Contents

# frozen_string_literal: true

module NgrokAPI
  module Models
    ##
    # A resource representing data from the api_keys API
    class ApiKey
      attr_reader :id,
        :client,
        :created_at,
        :description,
        :metadata,
        :result,
        :token,
        :uri

      def initialize(client:, result:)
        @client = client
        @result = result
        @created_at = @result['created_at']
        @id = @result['id']
        @description = @result['description']
        @metadata = @result['metadata']
        @token = @result['token']
        @uri = @result['uri']
      end

      def ==(other)
        @result == other.result
      end

      def to_s
        @result.to_s
      end

      ##
      # Delete this API key.
      #
      # @return [nil] result from delete request
      #
      # https://ngrok.com/docs/api#api-api-keys-delete
      def delete
        @client.delete(id: @id)
      end

      # rubocop:disable LineLength

      ##
      # Update the attributes of this API key.
      #
      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
      # @return [NgrokAPI::Models::ApiKey] result from update request
      #
      # https://ngrok.com/docs/api#api-api-keys-update
      def update(description: nil, metadata: nil)
        @description = description if description
        @metadata = metadata if metadata
        @client.update(id: @id, description: description, metadata: metadata)
      end
      # rubocop:enable LineLength
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ngrok-api-0.9.0	lib/ngrokapi/models/api_key.rb