twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/content/v2/content.rb

@@ -0,0 +1,433 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Content
+#    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 Content < ContentBase
+            class V2 < Version
+                class ContentList < ListResource
+                
+                    ##
+                    # Initialize the ContentList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ContentList] ContentList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Content"
+                        
+                    end
+                
+                    ##
+                    # Lists ContentInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] sort_by_date Whether to sort by ascending or descending date updated
+                    # @param [String] sort_by_content_name Whether to sort by ascending or descending content name
+                    # @param [Time] date_created_after Filter by >=[date-time]
+                    # @param [Time] date_created_before Filter by <=[date-time]
+                    # @param [String] content_name Filter by Regex Pattern in content name
+                    # @param [String] content Filter by Regex Pattern in template content
+                    # @param [Array[String]] language Filter by array of valid language(s)
+                    # @param [Array[String]] content_type Filter by array of contentType(s)
+                    # @param [Array[String]] channel_eligibility Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>
+                    # @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(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            sort_by_date: sort_by_date,
+                            sort_by_content_name: sort_by_content_name,
+                            date_created_after: date_created_after,
+                            date_created_before: date_created_before,
+                            content_name: content_name,
+                            content: content,
+                            language: language,
+                            content_type: content_type,
+                            channel_eligibility: channel_eligibility,
+                            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] sort_by_date Whether to sort by ascending or descending date updated
+                    # @param [String] sort_by_content_name Whether to sort by ascending or descending content name
+                    # @param [Time] date_created_after Filter by >=[date-time]
+                    # @param [Time] date_created_before Filter by <=[date-time]
+                    # @param [String] content_name Filter by Regex Pattern in content name
+                    # @param [String] content Filter by Regex Pattern in template content
+                    # @param [Array[String]] language Filter by array of valid language(s)
+                    # @param [Array[String]] content_type Filter by array of contentType(s)
+                    # @param [Array[String]] channel_eligibility Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>
+                    # @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(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            sort_by_date: sort_by_date,
+                            sort_by_content_name: sort_by_content_name,
+                            date_created_after: date_created_after,
+                            date_created_before: date_created_before,
+                            content_name: content_name,
+                            content: content,
+                            language: language,
+                            content_type: content_type,
+                            channel_eligibility: channel_eligibility,
+                            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 ContentPageMetadata records from the API as a list.
+                      # @param [String] sort_by_date Whether to sort by ascending or descending date updated
+                      # @param [String] sort_by_content_name Whether to sort by ascending or descending content name
+                      # @param [Time] date_created_after Filter by >=[date-time]
+                      # @param [Time] date_created_before Filter by <=[date-time]
+                      # @param [String] content_name Filter by Regex Pattern in content name
+                      # @param [String] content Filter by Regex Pattern in template content
+                      # @param [Array[String]] language Filter by array of valid language(s)
+                      # @param [Array[String]] content_type Filter by array of contentType(s)
+                      # @param [Array[String]] channel_eligibility Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>
+                    # @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(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'SortByDate' => sort_by_date,
+                            'SortByContentName' => sort_by_content_name,
+                            'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
+                            'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
+                            'ContentName' => content_name,
+                            'Content' => content,
+                            
+                            'Language' =>  Twilio.serialize_list(language) { |e| e },
+                            
+                            'ContentType' =>  Twilio.serialize_list(content_type) { |e| e },
+                            
+                            'ChannelEligibility' =>  Twilio.serialize_list(channel_eligibility) { |e| e },
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ContentPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ContentInstance 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 ContentInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] sort_by_date Whether to sort by ascending or descending date updated
+                    # @param [String] sort_by_content_name Whether to sort by ascending or descending content name
+                    # @param [Time] date_created_after Filter by >=[date-time]
+                    # @param [Time] date_created_before Filter by <=[date-time]
+                    # @param [String] content_name Filter by Regex Pattern in content name
+                    # @param [String] content Filter by Regex Pattern in template content
+                    # @param [Array[String]] language Filter by array of valid language(s)
+                    # @param [Array[String]] content_type Filter by array of contentType(s)
+                    # @param [Array[String]] channel_eligibility Filter by array of ChannelEligibility(s), where ChannelEligibility=<channel>:<status>
+                    # @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 ContentInstance
+                    def page(sort_by_date: :unset, sort_by_content_name: :unset, date_created_after: :unset, date_created_before: :unset, content_name: :unset, content: :unset, language: :unset, content_type: :unset, channel_eligibility: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'SortByDate' => sort_by_date,
+                            'SortByContentName' => sort_by_content_name,
+                            'DateCreatedAfter' =>  Twilio.serialize_iso8601_datetime(date_created_after),
+                            'DateCreatedBefore' =>  Twilio.serialize_iso8601_datetime(date_created_before),
+                            'ContentName' => content_name,
+                            'Content' => content,
+                            
+                            'Language' =>  Twilio.serialize_list(language) { |e| e },
+                            
+                            'ContentType' =>  Twilio.serialize_list(content_type) { |e| e },
+                            
+                            'ChannelEligibility' =>  Twilio.serialize_list(channel_eligibility) { |e| e },
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ContentPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ContentInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ContentInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ContentPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Content.V2.ContentList>'
+                    end
+                end
+
+                class ContentPage < Page
+                    ##
+                    # Initialize the ContentPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ContentPage] ContentPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ContentInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ContentInstance] ContentInstance
+                    def get_instance(payload)
+                        ContentInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Content.V2.ContentPage>'
+                    end
+                end
+
+                class ContentPageMetadata < PageMetadata
+                    attr_reader :content_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @content_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @content_page << ContentListResponse.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
+                        @content_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Content::V2PageMetadata>';
+                    end
+                end
+                class ContentListResponse < InstanceListResource
+
+                    # @param [Array<ContentInstance>] 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
+                      @content = data_list.map do |data|
+                        ContentInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def content
+                        @content
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ContentInstance < InstanceResource
+                    ##
+                    # Initialize the ContentInstance
+                    # @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 Content
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ContentInstance] ContentInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'language' => payload['language'],
+                            'variables' => payload['variables'],
+                            'types' => payload['types'],
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that that we created to identify the Content resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] A string name used to describe the Content resource. Not visible to the end recipient.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in.
+                    def language
+                        @properties['language']
+                    end
+                    
+                    ##
+                    # @return [Hash] Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}.
+                    def variables
+                        @properties['variables']
+                    end
+                    
+                    ##
+                    # @return [Hash] The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource.
+                    def types
+                        @properties['types']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of the resource, relative to `https://content.twilio.com`.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] A list of links related to the Content resource, such as approval_fetch and approval_create
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Content.V2.ContentInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Content.V2.ContentInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end