twilio-ruby 7.11.3 → 7.13.0

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

@@ -0,0 +1,722 @@
+##
+#    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 SharedKeyList < ListResource
+                
+                    class PatchSharedKey
+                            # @param [friendly_name]: [String] Human-readable name for the SharedKey
+                        attr_accessor :friendly_name
+                        def initialize(payload)
+                                @friendly_name = payload["friendly_name"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "friendlyName": @friendly_name,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PostSharedKey
+                            # @param [friendly_name]: [String] Human-readable name for the signing key (optional, defaults to blank)
+                        attr_accessor :friendly_name
+                        def initialize(payload)
+                                @friendly_name = payload["friendly_name"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "friendlyName": @friendly_name,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class PatchSharedKey
+                            # @param [friendly_name]: [String] Human-readable name for the SharedKey
+                        attr_accessor :friendly_name
+                        def initialize(payload)
+                                @friendly_name = payload["friendly_name"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "friendlyName": @friendly_name,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PostSharedKey
+                            # @param [friendly_name]: [String] Human-readable name for the signing key (optional, defaults to blank)
+                        attr_accessor :friendly_name
+                        def initialize(payload)
+                                @friendly_name = payload["friendly_name"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "friendlyName": @friendly_name,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the SharedKeyList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SharedKeyList] SharedKeyList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Webhooks/SharedKeys"
+                        
+                    end
+                    ##
+                    # Create the SharedKeyInstance
+                    # @param [String] idempotency_key Idempotency key for mutation operations. Must be a UUIDv7 (other UUID versions are rejected with a 400).
+                    # @param [PostSharedKey] post_shared_key 
+                    # @return [SharedKeyInstance] Created SharedKeyInstance
+                    def create(
+                      idempotency_key: :unset,
+                      post_shared_key: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        payload = @version.create('POST', @uri, headers: headers, data: post_shared_key.to_json)
+                        SharedKeyInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the SharedKeyInstanceMetadata
+                    # @param [String] idempotency_key Idempotency key for mutation operations. Must be a UUIDv7 (other UUID versions are rejected with a 400).
+                    # @param [PostSharedKey] post_shared_key 
+                    # @return [SharedKeyInstance] Created SharedKeyInstance
+                    def create_with_metadata(
+                      idempotency_key: :unset,
+                    post_shared_key: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: post_shared_key.to_json)
+                        shared_key_instance = SharedKeyInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SharedKeyInstanceMetadata.new(
+                            @version,
+                            shared_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists SharedKeyInstance 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 SharedKeyPageMetadata 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)
+
+                        SharedKeyPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields SharedKeyInstance 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 SharedKeyInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token Token for pagination
+                    
+                    # @return [Page] Page of SharedKeyInstance
+                    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)
+
+                        SharedKeyPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of SharedKeyInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of SharedKeyInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    SharedKeyPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Webhooks.V1.SharedKeyList>'
+                    end
+                end
+
+
+                class SharedKeyContext < InstanceContext
+                    ##
+                    # Initialize the SharedKeyContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] shared_key_id 
+                    # @return [SharedKeyContext] SharedKeyContext
+                    def initialize(version, shared_key_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { shared_key_id: shared_key_id,  }
+                        @uri = "/Webhooks/SharedKeys/#{@solution[:shared_key_id]}"
+
+                        
+                    end
+                    ##
+                    # Delete the SharedKeyInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        SharedKeyInstance.new(
+                          @version,
+                          response.body,
+                            shared_key_id: @solution[:shared_key_id],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the SharedKeyInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          sharedKey_instance = SharedKeyInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SharedKeyInstanceMetadata.new(@version, sharedKey_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the SharedKeyInstance
+                    # @return [SharedKeyInstance] Fetched SharedKeyInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        SharedKeyInstance.new(
+                            @version,
+                            payload,
+                            shared_key_id: @solution[:shared_key_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the SharedKeyInstanceMetadata
+                    # @return [SharedKeyInstance] Fetched SharedKeyInstance
+                    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)
+                        shared_key_instance = SharedKeyInstance.new(
+                            @version,
+                            response.body,
+                            shared_key_id: @solution[:shared_key_id],
+                        )
+                        SharedKeyInstanceMetadata.new(
+                            @version,
+                            shared_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the SharedKeyInstance
+                    # @param [PatchSharedKey] patch_shared_key 
+                    # @return [SharedKeyInstance] Patched SharedKeyInstance
+                    def patch(patch_shared_key: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        payload = @version.patch('PATCH', @uri, headers: headers, data: patch_shared_key.to_json)
+                        SharedKeyInstance.new(
+                            @version,
+                            payload,
+                            shared_key_id: @solution[:shared_key_id],
+                        )
+                    end
+
+                    ##
+                    # Patch the SharedKeyInstanceMetadata
+                    # @param [PatchSharedKey] patch_shared_key 
+                    # @return [SharedKeyInstance] Patchd SharedKeyInstance
+                    def patch_with_metadata(patch_shared_key: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                         headers['Accept'] = '*/*'
+                        response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: patch_shared_key.to_json)
+                        shared_key_instance = SharedKeyInstance.new(
+                            @version,
+                            response.body,
+                            shared_key_id: @solution[:shared_key_id],
+                        )
+                        SharedKeyInstanceMetadata.new(
+                            @version,
+                            shared_key_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.SharedKeyContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Webhooks.V1.SharedKeyContext #{context}>"
+                    end
+                end
+
+                class SharedKeyInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SharedKeyInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SharedKeyInstance] shared_key_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 [SharedKeyInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, shared_key_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @shared_key_instance = shared_key_instance
+                    end
+
+                    def shared_key
+                        @shared_key_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SharedKeyInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SharedKeyListResponse < InstanceListResource
+                    # @param [Array<SharedKeyInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @shared_key_instance = payload.body[key].map do |data|
+                        SharedKeyInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def shared_key_instance
+                          @instance
+                      end
+                  end
+
+                class SharedKeyPage < TokenPage
+                    ##
+                    # Initialize the SharedKeyPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SharedKeyPage] SharedKeyPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SharedKeyInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SharedKeyInstance] SharedKeyInstance
+                    def get_instance(payload)
+                        SharedKeyInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Webhooks.V1.SharedKeyPage>'
+                    end
+                end
+
+                class SharedKeyPageMetadata < PageMetadata
+                    attr_reader :shared_key_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @shared_key_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @shared_key_page << SharedKeyListResponse.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
+                        @shared_key_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Webhooks::V1PageMetadata>';
+                    end
+                end
+                class SharedKeyListResponse < InstanceListResource
+
+                    # @param [Array<SharedKeyInstance>] 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
+                      @shared_key = data_list.map do |data|
+                        SharedKeyInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def shared_key
+                        @shared_key
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class SharedKeyInstance < InstanceResource
+                    ##
+                    # Initialize the SharedKeyInstance
+                    # @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 SharedKey
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SharedKeyInstance] SharedKeyInstance
+                    def initialize(version, payload , shared_key_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'friendly_name' => payload['friendly_name'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'secret' => payload['secret'],
+                            'type' => payload['type'],
+                            'title' => payload['title'],
+                            'status' => payload['status'] == nil ? payload['status'] : payload['status'].to_i,
+                            'detail' => payload['detail'],
+                            'code' => payload['code'] == nil ? payload['code'] : payload['code'].to_i,
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'shared_key_id' => shared_key_id  || @properties['shared_key_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 [SharedKeyContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = SharedKeyContext.new(@version , @params['shared_key_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Unique SharedKey identifier (TypeID/TTID format)
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] Human-readable name for identification
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [String] Signing secret (only returned on POST, cannot be retrieved later)
+                    def secret
+                        @properties['secret']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def type
+                        @properties['type']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def title
+                        @properties['title']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def detail
+                        @properties['detail']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # Delete the SharedKeyInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the SharedKeyInstance
+                    # @return [SharedKeyInstance] Fetched SharedKeyInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Patch the SharedKeyInstance
+                    # @param [PatchSharedKey] patch_shared_key 
+                    # @return [SharedKeyInstance] Patched SharedKeyInstance
+                    def patch(patch_shared_key: nil
+                    )
+
+                        context.patch(
+                            patch_shared_key: patch_shared_key, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Webhooks.V1.SharedKeyInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Webhooks.V1.SharedKeyInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end