messagemedia_signingkeys_sdk 1.0.0

data/lib/message_media_signing_keys/http/http_client.rb

@@ -0,0 +1,102 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/message_media_signing_keys/http/http_context.rb

@@ -0,0 +1,18 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # Represents an Http call in context.
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/message_media_signing_keys/http/http_method_enum.rb

@@ -0,0 +1,11 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/message_media_signing_keys/http/http_request.rb

@@ -0,0 +1,48 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/message_media_signing_keys/http/http_response.rb

@@ -0,0 +1,21 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # Http response received.
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end

data/lib/message_media_signing_keys/message_media_signing_keys_client.rb

@@ -0,0 +1,27 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  #  message_media_signing_keys client class.
+  class MessageMediaSigningKeysClient
+    # Singleton access to signature_key_management controller.
+    # @return [SignatureKeyManagementController] Returns the controller instance.
+    def signature_key_management
+      SignatureKeyManagementController.instance
+    end
+
+    # Returns the configuration class for easy access.
+    # @return [Configuration] Returns the actual configuration class.
+    def config
+      Configuration
+    end
+
+    # Initializer with authentication and configuration parameters.
+    def initialize(basic_auth_user_name: nil, basic_auth_password: nil)
+      Configuration.basic_auth_user_name = basic_auth_user_name if
+        basic_auth_user_name
+      Configuration.basic_auth_password = basic_auth_password if
+        basic_auth_password
+    end
+  end
+end

data/lib/message_media_signing_keys/models/base_model.rb

@@ -0,0 +1,34 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/message_media_signing_keys/models/create_signature_key_request.rb

@@ -0,0 +1,42 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # CreateSignatureKeyRequest Model.
+  class CreateSignatureKeyRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :digest
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cipher
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['digest'] = 'digest'
+      @_hash['cipher'] = 'cipher'
+      @_hash
+    end
+
+    def initialize(digest = nil,
+                   cipher = nil)
+      @digest = digest
+      @cipher = cipher
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      digest = hash['digest']
+      cipher = hash['cipher']
+
+      # Create object from extracted values.
+      CreateSignatureKeyRequest.new(digest,
+                                    cipher)
+    end
+  end
+end

data/lib/message_media_signing_keys/models/create_signature_key_response.rb

@@ -0,0 +1,78 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # CreateSignatureKeyResponse Model.
+  class CreateSignatureKeyResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :public_key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cipher
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :digest
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :enabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key_id'] = 'key_id'
+      @_hash['public_key'] = 'public_key'
+      @_hash['cipher'] = 'cipher'
+      @_hash['digest'] = 'digest'
+      @_hash['created'] = 'created'
+      @_hash['enabled'] = 'enabled'
+      @_hash
+    end
+
+    def initialize(key_id = nil,
+                   public_key = nil,
+                   cipher = nil,
+                   digest = nil,
+                   created = nil,
+                   enabled = nil)
+      @key_id = key_id
+      @public_key = public_key
+      @cipher = cipher
+      @digest = digest
+      @created = created
+      @enabled = enabled
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key_id = hash['key_id']
+      public_key = hash['public_key']
+      cipher = hash['cipher']
+      digest = hash['digest']
+      created = hash['created']
+      enabled = hash['enabled']
+
+      # Create object from extracted values.
+      CreateSignatureKeyResponse.new(key_id,
+                                     public_key,
+                                     cipher,
+                                     digest,
+                                     created,
+                                     enabled)
+    end
+  end
+end

data/lib/message_media_signing_keys/models/enable_signature_key_request.rb

@@ -0,0 +1,33 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # EnableSignatureKeyRequest Model.
+  class EnableSignatureKeyRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key_id'] = 'key_id'
+      @_hash
+    end
+
+    def initialize(key_id = nil)
+      @key_id = key_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key_id = hash['key_id']
+
+      # Create object from extracted values.
+      EnableSignatureKeyRequest.new(key_id)
+    end
+  end
+end

data/lib/message_media_signing_keys/models/enable_signature_key_response.rb

@@ -0,0 +1,69 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaSigningKeys
+  # EnableSignatureKeyResponse Model.
+  class EnableSignatureKeyResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cipher
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :digest
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :enabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key_id'] = 'key_id'
+      @_hash['cipher'] = 'cipher'
+      @_hash['digest'] = 'digest'
+      @_hash['created'] = 'created'
+      @_hash['enabled'] = 'enabled'
+      @_hash
+    end
+
+    def initialize(key_id = nil,
+                   cipher = nil,
+                   digest = nil,
+                   created = nil,
+                   enabled = nil)
+      @key_id = key_id
+      @cipher = cipher
+      @digest = digest
+      @created = created
+      @enabled = enabled
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key_id = hash['key_id']
+      cipher = hash['cipher']
+      digest = hash['digest']
+      created = hash['created']
+      enabled = hash['enabled']
+
+      # Create object from extracted values.
+      EnableSignatureKeyResponse.new(key_id,
+                                     cipher,
+                                     digest,
+                                     created,
+                                     enabled)
+    end
+  end
+end