twilio-ruby 7.11.3 → 7.13.0

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

@@ -0,0 +1,320 @@
+##
+#    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 EdgeZoneList < ListResource
+                
+                    ##
+                    # Initialize the EdgeZoneList
+                    # @param [Version] version Version that contains the resource
+                    # @return [EdgeZoneList] EdgeZoneList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Webhooks/EdgeZones"
+                        
+                    end
+                
+                    ##
+                    # Lists EdgeZoneInstance 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 [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, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            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 [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, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            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 EdgeZonePageMetadata records from the API as a list.
+                      # @param [String] page_token Token for pagination
+                    # @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, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EdgeZonePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields EdgeZoneInstance 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 EdgeZoneInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token Token for pagination
+                    
+                    # @return [Page] Page of EdgeZoneInstance
+                    def page(page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EdgeZonePage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of EdgeZoneInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of EdgeZoneInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    EdgeZonePage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Webhooks.V1.EdgeZoneList>'
+                    end
+                end
+
+                class EdgeZonePage < TokenPage
+                    ##
+                    # Initialize the EdgeZonePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [EdgeZonePage] EdgeZonePage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of EdgeZoneInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [EdgeZoneInstance] EdgeZoneInstance
+                    def get_instance(payload)
+                        EdgeZoneInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Webhooks.V1.EdgeZonePage>'
+                    end
+                end
+
+                class EdgeZonePageMetadata < PageMetadata
+                    attr_reader :edge_zone_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @edge_zone_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @edge_zone_page << EdgeZoneListResponse.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
+                        @edge_zone_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Webhooks::V1PageMetadata>';
+                    end
+                end
+                class EdgeZoneListResponse < InstanceListResource
+
+                    # @param [Array<EdgeZoneInstance>] 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
+                      @edge_zone = data_list.map do |data|
+                        EdgeZoneInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def edge_zone
+                        @edge_zone
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class EdgeZoneInstance < InstanceResource
+                    ##
+                    # Initialize the EdgeZoneInstance
+                    # @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 EdgeZone
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [EdgeZoneInstance] EdgeZoneInstance
+                    def initialize(version, payload )
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'friendly_name' => payload['friendly_name'],
+                            'description' => payload['description'],
+                            'edge_locations' => payload['edge_locations'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] Stable zone identifier. Use this value in Settings.edgeZones.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] Human-readable zone name.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] Routing guidance for this zone.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [Array<EdgeLocation>] PoPs currently active within this zone.
+                    def edge_locations
+                        @properties['edge_locations']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Webhooks.V1.EdgeZoneInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Webhooks.V1.EdgeZoneInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end