twilio-ruby 7.12.0 → 7.13.0

data/lib/twilio-ruby/rest/webhooks/v1/operation.rb

@@ -0,0 +1,513 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Webhooks Configuration
+#    Centralized webhook configuration with OAuth2 support, immutable resources, and zero-downtime credential rotation. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Webhooks < WebhooksBase
+            class V1 < Version
+                class OperationList < ListResource
+                
+                    ##
+                    # Initialize the OperationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OperationList] OperationList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Webhooks/Operations"
+                        
+                    end
+                
+                    ##
+                    # Lists OperationInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] page_token Token for pagination
+                    # @param [String] status Filter by operation state
+                    # @param [String] resource_id Filter operations affecting a specific resource 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(page_token: :unset, status: :unset, resource_id: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            status: status,
+                            resource_id: resource_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] page_token Token for pagination
+                    # @param [String] status Filter by operation state
+                    # @param [String] resource_id Filter operations affecting a specific resource 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(page_token: :unset, status: :unset, resource_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            status: status,
+                            resource_id: resource_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 OperationPageMetadata records from the API as a list.
+                      # @param [String] page_token Token for pagination
+                      # @param [String] status Filter by operation state
+                      # @param [String] resource_id Filter operations affecting a specific resource 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(page_token: :unset, status: :unset, resource_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'status' => status,
+                            'resourceId' => resource_id,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OperationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields OperationInstance 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 OperationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token Token for pagination
+                    # @param [String] status Filter by operation state
+                    # @param [String] resource_id Filter operations affecting a specific resource ID
+                    
+                    # @return [Page] Page of OperationInstance
+                    def page(page_token: :unset, status: :unset, resource_id: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'status' => status,
+                            'resourceId' => resource_id,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OperationPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of OperationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of OperationInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    OperationPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Webhooks.V1.OperationList>'
+                    end
+                end
+
+
+                class OperationContext < InstanceContext
+                    ##
+                    # Initialize the OperationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] operation_id 
+                    # @return [OperationContext] OperationContext
+                    def initialize(version, operation_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { operation_id: operation_id,  }
+                        @uri = "/Webhooks/Operations/#{@solution[:operation_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the OperationInstance
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        OperationInstance.new(
+                            @version,
+                            payload,
+                            operation_id: @solution[:operation_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the OperationInstanceMetadata
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        operation_instance = OperationInstance.new(
+                            @version,
+                            response.body,
+                            operation_id: @solution[:operation_id],
+                        )
+                        OperationInstanceMetadata.new(
+                            @version,
+                            operation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Webhooks.V1.OperationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Webhooks.V1.OperationContext #{context}>"
+                    end
+                end
+
+                class OperationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new OperationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}OperationInstance] operation_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 [OperationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, operation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @operation_instance = operation_instance
+                    end
+
+                    def operation
+                        @operation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.OperationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class OperationListResponse < InstanceListResource
+                    # @param [Array<OperationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @operation_instance = payload.body[key].map do |data|
+                        OperationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def operation_instance
+                          @instance
+                      end
+                  end
+
+                class OperationPage < TokenPage
+                    ##
+                    # Initialize the OperationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OperationPage] OperationPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OperationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OperationInstance] OperationInstance
+                    def get_instance(payload)
+                        OperationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Webhooks.V1.OperationPage>'
+                    end
+                end
+
+                class OperationPageMetadata < PageMetadata
+                    attr_reader :operation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @operation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @operation_page << OperationListResponse.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
+                        @operation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Webhooks::V1PageMetadata>';
+                    end
+                end
+                class OperationListResponse < InstanceListResource
+
+                    # @param [Array<OperationInstance>] 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
+                      @operation = data_list.map do |data|
+                        OperationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def operation
+                        @operation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class OperationInstance < InstanceResource
+                    ##
+                    # Initialize the OperationInstance
+                    # @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 Operation
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OperationInstance] OperationInstance
+                    def initialize(version, payload , operation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'status_url' => payload['status_url'],
+                            'status' => payload['status'],
+                            'error' => payload['error'],
+                            'resource_id' => payload['resource_id'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'completed_at' => Twilio.deserialize_iso8601_datetime(payload['completed_at']),
+                            'retention_period' => payload['retention_period'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'operation_id' => operation_id  || @properties['operation_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 [OperationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = OperationContext.new(@version , @params['operation_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Unique operation identifier (TypeID/TTID format)
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] URL to poll for operation status (same as Location header in 202 response)
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [String] Current state of the operation: - PENDING: Accepted, not yet started - RUNNING: Propagating to all regions (typically 30-60 seconds) - COMPLETED: Rule active globally - CANCELLED: Operation was cancelled before completion - FAILED: Operation could not complete; see error field for details 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [OperationError] Present only when status is FAILED
+                    def error
+                        @properties['error']
+                    end
+                    
+                    ##
+                    # @return [String] ID of the affected resource
+                    def resource_id
+                        @properties['resource_id']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def completed_at
+                        @properties['completed_at']
+                    end
+                    
+                    ##
+                    # @return [String] ISO-8601 duration for how long this Operation record is retained after creation (fixed at 7 days)
+                    def retention_period
+                        @properties['retention_period']
+                    end
+                    
+                    ##
+                    # Fetch the OperationInstance
+                    # @return [OperationInstance] Fetched OperationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Webhooks.V1.OperationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Webhooks.V1.OperationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end