apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/assess_update_transfer_request.rb

@@ -0,0 +1,123 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to assess the eligibility, risk, and prerequisites for
+  # updating a transfer. Inherits all properties from
+  # Gd.Bos.DataTransfer.Request.UpdateTransferRequest and is used to validate
+  # and pre-check a transfer update operation before execution, including
+  # authorization type, transfer endpoint, device information, and
+  # debit-to-negative settings. This assessment helps ensure compliance, risk
+  # mitigation, and business rule validation prior to performing the actual
+  # update.
+  class AssessUpdateTransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of authorization being requested for the transfer update (e.g.,
+    # "execute", "hold", "accept", "cancel", "reject", "system", "reverse").
+    # Determines the intended action for the transfer update.
+    # @return [String]
+    attr_accessor :transfer_authorization_type
+
+    # Represents the endpoint details for updating a transfer, such as the
+    # source or target of funds.
+    # Contains information about the endpoint type, unique identifier, and card
+    # data (encrypted or unencrypted) used in the transfer update process.
+    # Used to specify or modify the source or destination for a transfer during
+    # an update operation.
+    # @return [UpdateTransferEndpoint]
+    attr_accessor :transfer_endpoint
+
+    # Indicates whether the update allows the account to be debited to a
+    # negative balance (true if allowed).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :debit_to_negative
+
+    # Represents device-specific information used when initiating a transfer or
+    # other sensitive operation.
+    # Contains details about the device and network, such as device ID, make,
+    # model, operating system, and IP addresses.
+    # Used for device identification, risk assessment, auditing, and fraud
+    # prevention.
+    # @return [DeviceInfo]
+    attr_accessor :device
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_authorization_type'] = 'transferAuthorizationType'
+      @_hash['transfer_endpoint'] = 'transferEndpoint'
+      @_hash['debit_to_negative'] = 'debitToNegative'
+      @_hash['device'] = 'device'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_authorization_type
+        transfer_endpoint
+        debit_to_negative
+        device
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_authorization_type
+        debit_to_negative
+      ]
+    end
+
+    def initialize(transfer_authorization_type: SKIP, transfer_endpoint: SKIP,
+                   debit_to_negative: SKIP, device: SKIP)
+      unless transfer_authorization_type == SKIP
+        @transfer_authorization_type =
+          transfer_authorization_type
+      end
+      @transfer_endpoint = transfer_endpoint unless transfer_endpoint == SKIP
+      @debit_to_negative = debit_to_negative unless debit_to_negative == SKIP
+      @device = device unless device == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      transfer_authorization_type =
+        hash.key?('transferAuthorizationType') ? hash['transferAuthorizationType'] : SKIP
+      transfer_endpoint = UpdateTransferEndpoint.from_hash(hash['transferEndpoint']) if
+        hash['transferEndpoint']
+      debit_to_negative =
+        hash.key?('debitToNegative') ? hash['debitToNegative'] : SKIP
+      device = DeviceInfo.from_hash(hash['device']) if hash['device']
+
+      # Create object from extracted values.
+      AssessUpdateTransferRequest.new(transfer_authorization_type: transfer_authorization_type,
+                                      transfer_endpoint: transfer_endpoint,
+                                      debit_to_negative: debit_to_negative,
+                                      device: device)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_authorization_type: #{@transfer_authorization_type},"\
+      " transfer_endpoint: #{@transfer_endpoint}, debit_to_negative: #{@debit_to_negative},"\
+      " device: #{@device}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_authorization_type: #{@transfer_authorization_type.inspect},"\
+      " transfer_endpoint: #{@transfer_endpoint.inspect}, debit_to_negative:"\
+      " #{@debit_to_negative.inspect}, device: #{@device.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/assess_update_transfer_response.rb

@@ -0,0 +1,101 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after assessing an update to a transfer.
+  # Provides information about applicable limits that may affect the update
+  # operation, such as transaction amount, frequency, and remaining allowance.
+  # Used to determine compliance with business rules and regulatory requirements
+  # before performing a transfer update.
+  class AssessUpdateTransferResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of limits applicable to the transfer update, such as daily,
+    # monthly, or per-transaction limits.
+    # Each limit includes type, frequency, minimum/maximum amounts, and
+    # remaining allowance.
+    # @return [Array[Limit]]
+    attr_accessor :limits
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limits'] = 'limits'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limits
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        limits
+        response_details
+      ]
+    end
+
+    def initialize(limits: SKIP, response_details: SKIP)
+      @limits = limits unless limits == SKIP
+      @response_details = response_details unless response_details == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      limits = nil
+      unless hash['limits'].nil?
+        limits = []
+        hash['limits'].each do |structure|
+          limits << (Limit.from_hash(structure) if structure)
+        end
+      end
+
+      limits = SKIP unless hash.key?('limits')
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      AssessUpdateTransferResponse.new(limits: limits,
+                                       response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limits: #{@limits}, response_details: #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limits: #{@limits.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/atm_location.rb

@@ -0,0 +1,153 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the details of an ATM location, including name, address,
+  # geographic coordinates, and distance from a reference point. Used in ATM
+  # locator responses to provide information about available ATM locations.
+  class AtmLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the ATM location (e.g., bank or retail location name).
+    # @return [String]
+    attr_accessor :name
+
+    # The street address of the ATM location.
+    # @return [String]
+    attr_accessor :address
+
+    # The city where the ATM is located.
+    # @return [String]
+    attr_accessor :city
+
+    # The state or province where the ATM is located.
+    # @return [String]
+    attr_accessor :state
+
+    # The postal or ZIP code for the ATM location.
+    # @return [String]
+    attr_accessor :zip
+
+    # The country where the ATM is located.
+    # @return [String]
+    attr_accessor :country
+
+    # The longitude coordinate of the ATM location.
+    # @return [String]
+    attr_accessor :longitude
+
+    # The latitude coordinate of the ATM location.
+    # @return [String]
+    attr_accessor :latitude
+
+    # The distance from the reference point to the ATM location, typically in
+    # miles or kilometers.
+    # @return [Float]
+    attr_accessor :distance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['longitude'] = 'longitude'
+      @_hash['latitude'] = 'latitude'
+      @_hash['distance'] = 'distance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        address
+        city
+        state
+        zip
+        country
+        longitude
+        latitude
+        distance
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        address
+        city
+        state
+        zip
+        country
+        longitude
+        latitude
+      ]
+    end
+
+    def initialize(name: SKIP, address: SKIP, city: SKIP, state: SKIP,
+                   zip: SKIP, country: SKIP, longitude: SKIP, latitude: SKIP,
+                   distance: SKIP)
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @longitude = longitude unless longitude == SKIP
+      @latitude = latitude unless latitude == SKIP
+      @distance = distance unless distance == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      longitude = hash.key?('longitude') ? hash['longitude'] : SKIP
+      latitude = hash.key?('latitude') ? hash['latitude'] : SKIP
+      distance = hash.key?('distance') ? hash['distance'] : SKIP
+
+      # Create object from extracted values.
+      AtmLocation.new(name: name,
+                      address: address,
+                      city: city,
+                      state: state,
+                      zip: zip,
+                      country: country,
+                      longitude: longitude,
+                      latitude: latitude,
+                      distance: distance)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, address: #{@address}, city: #{@city}, state: #{@state},"\
+      " zip: #{@zip}, country: #{@country}, longitude: #{@longitude}, latitude: #{@latitude},"\
+      " distance: #{@distance}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, address: #{@address.inspect}, city:"\
+      " #{@city.inspect}, state: #{@state.inspect}, zip: #{@zip.inspect}, country:"\
+      " #{@country.inspect}, longitude: #{@longitude.inspect}, latitude: #{@latitude.inspect},"\
+      " distance: #{@distance.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/attachment_type.rb

@@ -0,0 +1,36 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # The type of attachment being uploaded (e.g., MLA document, SCRA document).
+  class AttachmentType
+    ATTACHMENT_TYPE = [
+      # TODO: Write general description for MLADOCUMENT
+      MLADOCUMENT = 'MLADocument'.freeze,
+
+      # TODO: Write general description for SCRADOCUMENT
+      SCRADOCUMENT = 'SCRADocument'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MLADOCUMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mladocument' then MLADOCUMENT
+      when 'scradocument' then SCRADOCUMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/gd_bos_v1/models/authentication_request.rb

@@ -0,0 +1,75 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to authenticate a user. Contains grant type, scope, and
+  # authorization header for authentication.
+  class AuthenticationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The OAuth grant type (e.g., "password", "client_credentials").
+    # @return [String]
+    attr_accessor :grant_type
+
+    # The requested scope for the authentication (e.g., "openid profile").
+    # @return [String]
+    attr_accessor :scope
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['scope'] = 'scope'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        grant_type
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        grant_type
+        scope
+      ]
+    end
+
+    def initialize(grant_type: SKIP, scope: SKIP)
+      @grant_type = grant_type unless grant_type == SKIP
+      @scope = scope unless scope == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+
+      # Create object from extracted values.
+      AuthenticationRequest.new(grant_type: grant_type,
+                                scope: scope)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grant_type: #{@grant_type}, scope: #{@scope}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grant_type: #{@grant_type.inspect}, scope: #{@scope.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/authentication_response.rb

@@ -0,0 +1,119 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after a successful authentication. Contains
+  # access token, token type, expiration, and scope.
+  class AuthenticationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The access token issued to the client.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The type of token issued (e.g., "Bearer").
+    # @return [String]
+    attr_accessor :token_type
+
+    # The lifetime in seconds of the access token.
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # The scope of the access token.
+    # @return [String]
+    attr_accessor :scope
+
+    # Required: A list of response details providing status codes, descriptions,
+    # and additional information about the result of the operation.
+    # @return [Array[ResponseDetail]]
+    attr_accessor :response_details
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        access_token
+        token_type
+        expires_in
+        scope
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        access_token
+        token_type
+        expires_in
+        scope
+        response_details
+      ]
+    end
+
+    def initialize(access_token: SKIP, token_type: SKIP, expires_in: SKIP,
+                   scope: SKIP, response_details: SKIP)
+      @access_token = access_token unless access_token == SKIP
+      @token_type = token_type unless token_type == SKIP
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @response_details = response_details unless response_details == SKIP
+    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'] : SKIP
+      token_type = hash.key?('token_type') ? hash['token_type'] : SKIP
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      response_details = nil
+      unless hash['responseDetails'].nil?
+        response_details = []
+        hash['responseDetails'].each do |structure|
+          response_details << (ResponseDetail.from_hash(structure) if structure)
+        end
+      end
+
+      response_details = SKIP unless hash.key?('responseDetails')
+
+      # Create object from extracted values.
+      AuthenticationResponse.new(access_token: access_token,
+                                 token_type: token_type,
+                                 expires_in: expires_in,
+                                 scope: scope,
+                                 response_details: response_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token}, token_type: #{@token_type}, expires_in:"\
+      " #{@expires_in}, scope: #{@scope}, response_details: #{@response_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token.inspect}, token_type: #{@token_type.inspect},"\
+      " expires_in: #{@expires_in.inspect}, scope: #{@scope.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end