twilio-ruby 7.5.1 → 7.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aad54e4127225802d5b5d4a1e3711e2237721b9b
-  data.tar.gz: 33661730ed8d04136f1d82c41d06637efacba9f2
+  metadata.gz: d712ec9531d94615ce16b7b859693eb92efe8aef
+  data.tar.gz: 81f4f2fe625f922615d0874cfe652058d6419229
 SHA512:
-  metadata.gz: c4ab77c9062fc59a357c9ee328461b8d1d65a940cd90316abe2c1c31e519e2c8929f9185bcd167f4076783f1c355f073945acad8edc45aa6c624608a77ce6b92
-  data.tar.gz: ac5416a1673ba49aafef4a58dc5f5dbb77a88dec86e620c97cf2a04fd9f10f9fc8fa6ba761d9ab22f70375d6fb5816b7aefbc05ccb8e943b74795fd39a0603f7
+  metadata.gz: 33d089a34b55b75c13a3643d14b02183c368906770af28917ef9a8441abffd73afb88c3495b9a6bf7a41868bc36372c18999fc04ff4f40376a8a4cb552bbe982
+  data.tar.gz: 103dbb5c6885d46b382df7083ad299fb278392af5c9326fb63ec1e66fb0ce5af1be8ade1b2d4598c1b71b684f98af6c631d16c03f2fd8389c2f6b47dfc0529ba

data/CHANGES.md

@@ -1,6 +1,12 @@
 twilio-ruby changelog
 =====================
 
+[2025-04-07] Version 7.5.2
+--------------------------
+**Studio**
+- Add documentation for parent_step_sid field in Step resource
+
+
 [2025-03-20] Version 7.5.1
 --------------------------
 **Accounts**

data/README.md

@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 7.5.1'
+gem 'twilio-ruby', '~> 7.5.2'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 7.5.1
+gem install twilio-ruby -v 7.5.2
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/client.rb

@@ -92,6 +92,11 @@ module Twilio
                 @ip_messaging ||= IpMessaging.new self
             end
             ##
+            # Access the Knowledge Twilio Domain
+            def knowledge
+                @knowledge ||= Knowledge.new self
+            end
+            ##
             # Access the Lookups Twilio Domain
             def lookups
                 @lookups ||= Lookups.new self

data/lib/twilio-ruby/rest/knowledge/v1/knowledge/chunk.rb

@@ -0,0 +1,232 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Knowledge
+#    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 Knowledge < KnowledgeBase
+            class V1 < Version
+                class Knowledge < InstanceContext
+
+                     class ChunkList < ListResource
+                
+                    ##
+                    # Initialize the ChunkList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ChunkList] ChunkList
+                    def initialize(version, id: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { id: id }
+                        @uri = "/Knowledge/#{@solution[:id]}/Chunks"
+                        
+                    end
+                
+                    ##
+                    # Lists ChunkInstance 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
+
+                    ##
+                    # When passed a block, yields ChunkInstance 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 ChunkInstance 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 ChunkInstance
+                    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)
+
+                        ChunkPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ChunkInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ChunkInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ChunkPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V1.ChunkList>'
+                    end
+                end
+
+                class ChunkPage < Page
+                    ##
+                    # Initialize the ChunkPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ChunkPage] ChunkPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ChunkInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ChunkInstance] ChunkInstance
+                    def get_instance(payload)
+                        ChunkInstance.new(@version, payload, id: @solution[:id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V1.ChunkPage>'
+                    end
+                end
+                class ChunkInstance < InstanceResource
+                    ##
+                    # Initialize the ChunkInstance
+                    # @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 Chunk
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ChunkInstance] ChunkInstance
+                    def initialize(version, payload , id: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'content' => payload['content'],
+                            'metadata' => payload['metadata'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The chunk content.
+                    def content
+                        @properties['content']
+                    end
+                    
+                    ##
+                    # @return [Hash] The metadata of the chunk.
+                    def metadata
+                        @properties['metadata']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Chunk 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 Chunk was 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.Knowledge.V1.ChunkInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Knowledge.V1.ChunkInstance>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

data/lib/twilio-ruby/rest/knowledge/v1/knowledge/knowledge_status.rb

@@ -0,0 +1,213 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Knowledge
+#    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 Knowledge < KnowledgeBase
+            class V1 < Version
+                class Knowledge < InstanceContext
+
+                     class KnowledgeStatusList < ListResource
+                
+                    ##
+                    # Initialize the KnowledgeStatusList
+                    # @param [Version] version Version that contains the resource
+                    # @return [KnowledgeStatusList] KnowledgeStatusList
+                    def initialize(version, id: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { id: id }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Knowledge.V1.KnowledgeStatusList>'
+                    end
+                end
+
+
+                class KnowledgeStatusContext < InstanceContext
+                    ##
+                    # Initialize the KnowledgeStatusContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id the Knowledge ID.
+                    # @return [KnowledgeStatusContext] KnowledgeStatusContext
+                    def initialize(version, id)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { id: id,  }
+                        @uri = "/Knowledge/#{@solution[:id]}/Status"
+
+                        
+                    end
+                    ##
+                    # Fetch the KnowledgeStatusInstance
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        KnowledgeStatusInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V1.KnowledgeStatusContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Knowledge.V1.KnowledgeStatusContext #{context}>"
+                    end
+                end
+
+                class KnowledgeStatusPage < Page
+                    ##
+                    # Initialize the KnowledgeStatusPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [KnowledgeStatusPage] KnowledgeStatusPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of KnowledgeStatusInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [KnowledgeStatusInstance] KnowledgeStatusInstance
+                    def get_instance(payload)
+                        KnowledgeStatusInstance.new(@version, payload, id: @solution[:id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Knowledge.V1.KnowledgeStatusPage>'
+                    end
+                end
+                class KnowledgeStatusInstance < InstanceResource
+                    ##
+                    # Initialize the KnowledgeStatusInstance
+                    # @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 KnowledgeStatus
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [KnowledgeStatusInstance] KnowledgeStatusInstance
+                    def initialize(version, payload , id: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'status' => payload['status'],
+                            'last_status' => payload['last_status'],
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id' => id  || @properties['id']  , }
+                    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 [KnowledgeStatusContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = KnowledgeStatusContext.new(@version , @params['id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The last status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def last_status
+                        @properties['last_status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Fetch the KnowledgeStatusInstance
+                    # @return [KnowledgeStatusInstance] Fetched KnowledgeStatusInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V1.KnowledgeStatusInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Knowledge.V1.KnowledgeStatusInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+