packageruby 1.1.1

data/lib/form3_public_api/controllers/users_controller.rb

@@ -0,0 +1,290 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # UsersController
+  class UsersController < BaseController
+    # List all users
+    # @param [Integer] page_number Optional parameter: Which page to select
+    # @param [Integer] page_size Optional parameter: Number of items to select
+    # @return [UserDetailsListResponse] response from the API call
+    def list_all_users(page_number: nil,
+                       page_size: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/users',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_size, key: 'page[size]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserDetailsListResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Create user
+    # @param [UserCreation] user_creation_request Optional parameter: Example:
+    # @return [UserCreationResponse] response from the API call
+    def create_user(user_creation_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/security/users',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(user_creation_request))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserCreationResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad request',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Conflict',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Delete user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [Integer] version Required parameter: Version
+    # @return [void] response from the API call
+    def delete_user(user_id,
+                    version)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/security/users/{user_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException)
+                   .local_error('409',
+                                'Conflict',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @return [UserDetailsResponse] response from the API call
+    def fetch_user(user_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/users/{user_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserDetailsResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Update user details
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [UserCreation] user_update_request Optional parameter: Example:
+    # @return [UserDetailsResponse] response from the API call
+    def update_user_details(user_id,
+                            user_update_request: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/security/users/{user_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .body_param(new_parameter(user_update_request))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserDetailsResponse.method(:from_hash))
+                   .local_error('400',
+                                'Bad request',
+                                ApiErrorException)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch access control list for user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [String] filter_record_type Optional parameter: Record type
+    # @param [String] filter_action Optional parameter: Access action
+    # @return [AceDetailsListResponse] response from the API call
+    def fetch_access_control_list_for_user(user_id,
+                                           filter_record_type: nil,
+                                           filter_action: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/users/{user_id}/aces',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(filter_record_type, key: 'filter[record_type]'))
+                   .query_param(new_parameter(filter_action, key: 'filter[action]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(AceDetailsListResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch credentials for user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @return [UserCredentialListResponse] response from the API call
+    def fetch_credentials_for_user(user_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/users/{user_id}/credentials',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserCredentialListResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Create new credentials for user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @return [CredentialCreationResponse] response from the API call
+    def create_new_credentials_for_user(user_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/security/users/{user_id}/credentials',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(CredentialCreationResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Delete credentials for user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [String] client_id Required parameter: client id
+    # @return [void] response from the API call
+    def delete_credentials_for_user(user_id,
+                                    client_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/security/users/{user_id}/credentials/{client_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(client_id, key: 'client_id')
+                                    .should_encode(true))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Fetch all roles for user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @return [UserRoleListResponse] response from the API call
+    def fetch_all_roles_for_user(user_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/security/users/{user_id}/roles',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UserRoleListResponse.method(:from_hash))
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Remove role from user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @return [void] response from the API call
+    def remove_role_from_user(user_id,
+                              role_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/security/users/{user_id}/roles/{role_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .should_encode(true))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+
+    # Add role to user
+    # @param [UUID | String] user_id Required parameter: User Id
+    # @param [UUID | String] role_id Required parameter: Role Id
+    # @return [void] response from the API call
+    def add_role_to_user(user_id,
+                         role_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/security/users/{user_id}/roles/{role_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(role_id, key: 'role_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
+                   .auth(Single.new('OAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error('404',
+                                'Not Found',
+                                ApiErrorException))
+        .execute
+    end
+  end
+end

data/lib/form3_public_api/exceptions/api_error_exception.rb

@@ -0,0 +1,37 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ApiError class.
+  class ApiErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+    end
+  end
+end

data/lib/form3_public_api/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+  end
+end

data/lib/form3_public_api/exceptions/metrics_query_response_error_exception.rb

@@ -0,0 +1,52 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MetricsQueryResponse_Error class.
+  class MetricsQueryResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PrometheusMetricData]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :warnings
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @data = PrometheusMetricData.from_hash(hash['data']) if hash['data']
+      @error = hash.key?('error') ? hash['error'] : SKIP
+      @error_type = hash.key?('errorType') ? hash['errorType'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @warnings = hash.key?('warnings') ? hash['warnings'] : SKIP
+    end
+  end
+end

data/lib/form3_public_api/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,48 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+  end
+end

data/lib/form3_public_api/http/auth/basic.rb

@@ -0,0 +1,50 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Utility class for basic authorization.
+  class Basic < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'Basic: username or password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_credentials)
+      auth_params = {}
+      unless basic_credentials.nil? ||
+             basic_credentials.username.nil? ||
+             basic_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_credentials.username,
+                                                       basic_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicCredentials.
+  class BasicCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/form3_public_api/http/auth/o_auth2.rb

@@ -0,0 +1,89 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuth2: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(o_auth2_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = o_auth2_credentials.o_auth_client_id unless
+        o_auth2_credentials.nil? || o_auth2_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = o_auth2_credentials.o_auth_client_secret unless
+        o_auth2_credentials.nil? || o_auth2_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = o_auth2_credentials.o_auth_token unless
+        o_auth2_credentials.nil? || o_auth2_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_auth2(
+        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 OAuth2Credentials.
+  class OAuth2Credentials
+    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
+
+      OAuth2Credentials.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/form3_public_api/http/http_call_back.rb

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

data/lib/form3_public_api/http/http_method_enum.rb

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

data/lib/form3_public_api/http/http_request.rb

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

data/lib/form3_public_api/http/http_response.rb

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

data/lib/form3_public_api/models/acceptance_qualifier_enum.rb

@@ -0,0 +1,35 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # All accepted payments will receive the matching qualifier code
+  class AcceptanceQualifierEnum
+    ACCEPTANCE_QUALIFIER_ENUM = [
+      # TODO: Write general description for SOME_OTHER_TIME
+      SOME_OTHER_TIME = 'some_other_time'.freeze,
+
+      # TODO: Write general description for SAME_DAY
+      SAME_DAY = 'same_day'.freeze,
+
+      # TODO: Write general description for NEXT_CALENDAR_DAY
+      NEXT_CALENDAR_DAY = 'next_calendar_day'.freeze,
+
+      # TODO: Write general description for NEXT_WORKING_DAY
+      NEXT_WORKING_DAY = 'next_working_day'.freeze,
+
+      # TODO: Write general description for AFTER_NEXT_WORKING_DAY
+      AFTER_NEXT_WORKING_DAY = 'after_next_working_day'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCEPTANCE_QUALIFIER_ENUM.include?(value)
+    end
+  end
+end