multi-auth-project-sdk 1.0.0

data/lib/multi_auth_sample/http/auth/o_auth_bearer_token.rb

@@ -0,0 +1,42 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuthBearerToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuthBearerToken: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(o_auth_bearer_token_credentials)
+      auth_params = {}
+      @_access_token = o_auth_bearer_token_credentials.access_token unless
+        o_auth_bearer_token_credentials.nil? || o_auth_bearer_token_credentials.access_token.nil?
+      auth_params['Authorization'] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for OAuthBearerTokenCredentials.
+  class OAuthBearerTokenCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      OAuthBearerTokenCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/multi_auth_sample/http/auth/o_auth_ccg.rb

@@ -0,0 +1,88 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuthCCG < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuthCCG: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(o_auth_ccg_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = o_auth_ccg_credentials.o_auth_client_id unless
+        o_auth_ccg_credentials.nil? || o_auth_ccg_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = o_auth_ccg_credentials.o_auth_client_secret unless
+        o_auth_ccg_credentials.nil? || o_auth_ccg_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = o_auth_ccg_credentials.o_auth_token unless
+        o_auth_ccg_credentials.nil? || o_auth_ccg_credentials.o_auth_token.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token_o_auth_ccg(
+        build_basic_auth_header,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for OAuthCCGCredentials.
+  class OAuthCCGCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_token
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_token = o_auth_token
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_token ||= self.o_auth_token
+
+      OAuthCCGCredentials.new(o_auth_client_id: o_auth_client_id,
+                              o_auth_client_secret: o_auth_client_secret,
+                              o_auth_token: o_auth_token)
+    end
+  end
+end

data/lib/multi_auth_sample/http/auth/o_auth_ropcg.rb

@@ -0,0 +1,120 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuthROPCG < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuthROPCG: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(o_auth_ropcg_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = o_auth_ropcg_credentials.o_auth_client_id unless
+        o_auth_ropcg_credentials.nil? || o_auth_ropcg_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = o_auth_ropcg_credentials.o_auth_client_secret unless
+        o_auth_ropcg_credentials.nil? || o_auth_ropcg_credentials.o_auth_client_secret.nil?
+      @_o_auth_username = o_auth_ropcg_credentials.o_auth_username unless
+        o_auth_ropcg_credentials.nil? || o_auth_ropcg_credentials.o_auth_username.nil?
+      @_o_auth_password = o_auth_ropcg_credentials.o_auth_password unless
+        o_auth_ropcg_credentials.nil? || o_auth_ropcg_credentials.o_auth_password.nil?
+      @_o_auth_token = o_auth_ropcg_credentials.o_auth_token unless
+        o_auth_ropcg_credentials.nil? || o_auth_ropcg_credentials.o_auth_token.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token_o_auth_ropcg(
+        build_basic_auth_header,
+        @_o_auth_username,
+        @_o_auth_password,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+
+    # Refreshes OAuth token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def refresh_token(additional_params: nil)
+      token = @_o_auth_api.refresh_token_o_auth_ropcg(
+        OAuthROPCG.build_basic_auth_header,
+        @_o_auth_token.refresh_token,
+        _field_parameters: additional_params
+      )
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+  end
+
+  # Data class for OAuthROPCGCredentials.
+  class OAuthROPCGCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_username,
+                :o_auth_password, :o_auth_token
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_username:,
+                   o_auth_password:, o_auth_token: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+      raise ArgumentError, 'o_auth_username cannot be nil' if o_auth_username.nil?
+      raise ArgumentError, 'o_auth_password cannot be nil' if o_auth_password.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_username = o_auth_username
+      @o_auth_password = o_auth_password
+      @o_auth_token = o_auth_token
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_username: nil, o_auth_password: nil,
+                   o_auth_token: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_username ||= self.o_auth_username
+      o_auth_password ||= self.o_auth_password
+      o_auth_token ||= self.o_auth_token
+
+      OAuthROPCGCredentials.new(o_auth_client_id: o_auth_client_id,
+                                o_auth_client_secret: o_auth_client_secret,
+                                o_auth_username: o_auth_username,
+                                o_auth_password: o_auth_password,
+                                o_auth_token: o_auth_token)
+    end
+  end
+end

data/lib/multi_auth_sample/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/multi_auth_sample/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/multi_auth_sample/http/http_request.rb

@@ -0,0 +1,10 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/multi_auth_sample/http/http_response.rb

@@ -0,0 +1,10 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/multi_auth_sample/models/base_model.rb

@@ -0,0 +1,62 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif 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
+      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/multi_auth_sample/models/o_auth_provider_error_enum.rb

@@ -0,0 +1,45 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # OAuth 2 Authorization error codes
+  class OAuthProviderErrorEnum
+    O_AUTH_PROVIDER_ERROR_ENUM = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR_ENUM.include?(value)
+    end
+  end
+end

data/lib/multi_auth_sample/models/o_auth_scope_o_auth_acg_enum.rb

@@ -0,0 +1,20 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # OAuth 2 scopes supported by the API
+  class OAuthScopeOAuthACGEnum
+    O_AUTH_SCOPE_O_AUTH_ACG_ENUM = [
+      # Read request for files
+      READ_SCOPE = 'file_requests.read'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_SCOPE_O_AUTH_ACG_ENUM.include?(value)
+    end
+  end
+end

data/lib/multi_auth_sample/models/o_auth_token.rb

@@ -0,0 +1,110 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil,
+                   token_type = nil,
+                   expires_in = SKIP,
+                   scope = SKIP,
+                   expiry = SKIP,
+                   refresh_token = SKIP,
+                   additional_properties = {})
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token,
+                     hash)
+    end
+  end
+end

data/lib/multi_auth_sample/models/service_status.rb

@@ -0,0 +1,129 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # ServiceStatus Model.
+  class ServiceStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :app
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :moto
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :notes
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :users
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :os
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :php_version
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['app'] = 'app'
+      @_hash['moto'] = 'moto'
+      @_hash['notes'] = 'notes'
+      @_hash['users'] = 'users'
+      @_hash['time'] = 'time'
+      @_hash['os'] = 'os'
+      @_hash['php_version'] = 'php_version'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        app
+        moto
+        notes
+        users
+        time
+        os
+        php_version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = nil,
+                   app = SKIP,
+                   moto = SKIP,
+                   notes = SKIP,
+                   users = SKIP,
+                   time = SKIP,
+                   os = SKIP,
+                   php_version = SKIP,
+                   additional_properties = {})
+      @app = app unless app == SKIP
+      @moto = moto unless moto == SKIP
+      @notes = notes unless notes == SKIP
+      @users = users unless users == SKIP
+      @time = time unless time == SKIP
+      @os = os unless os == SKIP
+      @php_version = php_version unless php_version == SKIP
+      @status = status
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : nil
+      app = hash.key?('app') ? hash['app'] : SKIP
+      moto = hash.key?('moto') ? hash['moto'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      users = hash.key?('users') ? hash['users'] : SKIP
+      time = hash.key?('time') ? hash['time'] : SKIP
+      os = hash.key?('os') ? hash['os'] : SKIP
+      php_version = hash.key?('php_version') ? hash['php_version'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ServiceStatus.new(status,
+                        app,
+                        moto,
+                        notes,
+                        users,
+                        time,
+                        os,
+                        php_version,
+                        hash)
+    end
+  end
+end