apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/kyc_gate.rb

@@ -0,0 +1,67 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a Know Your Customer (KYC) gate, containing the current KYC state
+  # data for a user or account.
+  class KycGate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the Know Your Customer (KYC) state data for a user.
+    # Contains information about OFAC (Office of Foreign Assets Control)
+    # screening status, overall KYC status, and any pending KYC gates.
+    # Used to track regulatory compliance and the current state of user
+    # verification during onboarding or account management.
+    # @return [KycStateData]
+    attr_accessor :kyc_state_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kyc_state_data'] = 'kycStateData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        kyc_state_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kyc_state_data: SKIP)
+      @kyc_state_data = kyc_state_data unless kyc_state_data == 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.
+      kyc_state_data = KycStateData.from_hash(hash['kycStateData']) if hash['kycStateData']
+
+      # Create object from extracted values.
+      KycGate.new(kyc_state_data: kyc_state_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_state_data: #{@kyc_state_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} kyc_state_data: #{@kyc_state_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/kyc_state_data.rb

@@ -0,0 +1,98 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the Know Your Customer (KYC) state data for a user. Contains
+  # information about OFAC (Office of Foreign Assets Control) screening status,
+  # overall KYC status, and any pending KYC gates. Used to track regulatory
+  # compliance and the current state of user verification during onboarding or
+  # account management.
+  class KycStateData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The OFAC (Office of Foreign Assets Control) screening status for the user.
+    # Typical values: "Passed", "Failed", "Pending", or other business-specific
+    # status indicators.
+    # @return [String]
+    attr_accessor :ofac_status
+
+    # The overall KYC (Know Your Customer) status for the user.
+    # Typical values: "Verified", "Pending", "Failed", or other
+    # business-specific status indicators.
+    # @return [String]
+    attr_accessor :kyc_status
+
+    # The name or code of any pending KYC gate or step that must be completed
+    # for full verification.
+    # Example: "DocumentVerification", "AddressCheck", or null if no gates are
+    # pending.
+    # @return [String]
+    attr_accessor :kyc_pending_gate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ofac_status'] = 'ofacStatus'
+      @_hash['kyc_status'] = 'kycStatus'
+      @_hash['kyc_pending_gate'] = 'kycPendingGate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ofac_status
+        kyc_status
+        kyc_pending_gate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ofac_status
+        kyc_status
+        kyc_pending_gate
+      ]
+    end
+
+    def initialize(ofac_status: SKIP, kyc_status: SKIP, kyc_pending_gate: SKIP)
+      @ofac_status = ofac_status unless ofac_status == SKIP
+      @kyc_status = kyc_status unless kyc_status == SKIP
+      @kyc_pending_gate = kyc_pending_gate unless kyc_pending_gate == 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.
+      ofac_status = hash.key?('ofacStatus') ? hash['ofacStatus'] : SKIP
+      kyc_status = hash.key?('kycStatus') ? hash['kycStatus'] : SKIP
+      kyc_pending_gate =
+        hash.key?('kycPendingGate') ? hash['kycPendingGate'] : SKIP
+
+      # Create object from extracted values.
+      KycStateData.new(ofac_status: ofac_status,
+                       kyc_status: kyc_status,
+                       kyc_pending_gate: kyc_pending_gate)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ofac_status: #{@ofac_status}, kyc_status: #{@kyc_status}, kyc_pending_gate:"\
+      " #{@kyc_pending_gate}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ofac_status: #{@ofac_status.inspect}, kyc_status: #{@kyc_status.inspect},"\
+      " kyc_pending_gate: #{@kyc_pending_gate.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/limit.rb

@@ -0,0 +1,168 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents a financial or transactional limit applied to an account, user,
+  # or operation. Contains information about the type, frequency, minimum and
+  # maximum allowed amounts, remaining amount, and other limit-related metadata.
+  # Used to enforce business rules, compliance, and risk controls for transfers,
+  # withdrawals, or other financial activities.
+  class Limit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of limit (e.g., "Transfer", "Withdrawal", "Deposit").
+    # @return [String]
+    attr_accessor :type
+
+    # The frequency at which the limit applies (e.g., "Daily", "Monthly",
+    # "PerTransaction").
+    # @return [String]
+    attr_accessor :frequency
+
+    # The minimum amount allowed for the operation, in the relevant currency.
+    # @return [Float]
+    attr_accessor :minimum_amount
+
+    # The maximum amount allowed for the operation, in the relevant currency.
+    # @return [Float]
+    attr_accessor :maximum_amount
+
+    # The remaining amount available under this limit for the current period or
+    # context.
+    # @return [Float]
+    attr_accessor :amount_remaining
+
+    # The date and time when the initial transfer or operation was performed, if
+    # applicable.
+    # @return [DateTime]
+    attr_accessor :initial_transfer_date_time
+
+    # Indicates whether subsequent transfers or operations are allowed after the
+    # initial one.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :subsequent_transfer_allowed
+
+    # The number of times the operation has been performed or the count of
+    # transactions within the limit period.
+    # @return [Integer]
+    attr_accessor :count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['frequency'] = 'frequency'
+      @_hash['minimum_amount'] = 'minimumAmount'
+      @_hash['maximum_amount'] = 'maximumAmount'
+      @_hash['amount_remaining'] = 'amountRemaining'
+      @_hash['initial_transfer_date_time'] = 'initialTransferDateTime'
+      @_hash['subsequent_transfer_allowed'] = 'subsequentTransferAllowed'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        frequency
+        minimum_amount
+        maximum_amount
+        amount_remaining
+        initial_transfer_date_time
+        subsequent_transfer_allowed
+        count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        type
+        frequency
+        amount_remaining
+        initial_transfer_date_time
+        subsequent_transfer_allowed
+        count
+      ]
+    end
+
+    def initialize(type: SKIP, frequency: SKIP, minimum_amount: SKIP,
+                   maximum_amount: SKIP, amount_remaining: SKIP,
+                   initial_transfer_date_time: SKIP,
+                   subsequent_transfer_allowed: SKIP, count: SKIP)
+      @type = type unless type == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @minimum_amount = minimum_amount unless minimum_amount == SKIP
+      @maximum_amount = maximum_amount unless maximum_amount == SKIP
+      @amount_remaining = amount_remaining unless amount_remaining == SKIP
+      unless initial_transfer_date_time == SKIP
+        @initial_transfer_date_time =
+          initial_transfer_date_time
+      end
+      unless subsequent_transfer_allowed == SKIP
+        @subsequent_transfer_allowed =
+          subsequent_transfer_allowed
+      end
+      @count = count unless count == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      minimum_amount = hash.key?('minimumAmount') ? hash['minimumAmount'] : SKIP
+      maximum_amount = hash.key?('maximumAmount') ? hash['maximumAmount'] : SKIP
+      amount_remaining =
+        hash.key?('amountRemaining') ? hash['amountRemaining'] : SKIP
+      initial_transfer_date_time = if hash.key?('initialTransferDateTime')
+                                     (DateTimeHelper.from_rfc3339(hash['initialTransferDateTime']) if hash['initialTransferDateTime'])
+                                   else
+                                     SKIP
+                                   end
+      subsequent_transfer_allowed =
+        hash.key?('subsequentTransferAllowed') ? hash['subsequentTransferAllowed'] : SKIP
+      count = hash.key?('count') ? hash['count'] : SKIP
+
+      # Create object from extracted values.
+      Limit.new(type: type,
+                frequency: frequency,
+                minimum_amount: minimum_amount,
+                maximum_amount: maximum_amount,
+                amount_remaining: amount_remaining,
+                initial_transfer_date_time: initial_transfer_date_time,
+                subsequent_transfer_allowed: subsequent_transfer_allowed,
+                count: count)
+    end
+
+    def to_custom_initial_transfer_date_time
+      DateTimeHelper.to_rfc3339(initial_transfer_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, frequency: #{@frequency}, minimum_amount:"\
+      " #{@minimum_amount}, maximum_amount: #{@maximum_amount}, amount_remaining:"\
+      " #{@amount_remaining}, initial_transfer_date_time: #{@initial_transfer_date_time},"\
+      " subsequent_transfer_allowed: #{@subsequent_transfer_allowed}, count: #{@count}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, frequency: #{@frequency.inspect}, minimum_amount:"\
+      " #{@minimum_amount.inspect}, maximum_amount: #{@maximum_amount.inspect}, amount_remaining:"\
+      " #{@amount_remaining.inspect}, initial_transfer_date_time:"\
+      " #{@initial_transfer_date_time.inspect}, subsequent_transfer_allowed:"\
+      " #{@subsequent_transfer_allowed.inspect}, count: #{@count.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/line.rb

@@ -0,0 +1,86 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a line item containing product and inventory information.
+  class Line < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets the type of the line.
+    # @return [String]
+    attr_accessor :line_type
+
+    # Gets or sets the product code associated with the line.
+    # @return [String]
+    attr_accessor :product_code
+
+    # Gets or sets the inventory code for the line.
+    # @return [String]
+    attr_accessor :inventory_code
+
+    # Gets or sets the quantity for the line.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_type'] = 'lineType'
+      @_hash['product_code'] = 'productCode'
+      @_hash['inventory_code'] = 'inventoryCode'
+      @_hash['quantity'] = 'quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_type:, product_code:, inventory_code:, quantity:)
+      @line_type = line_type
+      @product_code = product_code
+      @inventory_code = inventory_code
+      @quantity = quantity
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      line_type = hash.key?('lineType') ? hash['lineType'] : nil
+      product_code = hash.key?('productCode') ? hash['productCode'] : nil
+      inventory_code = hash.key?('inventoryCode') ? hash['inventoryCode'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+
+      # Create object from extracted values.
+      Line.new(line_type: line_type,
+               product_code: product_code,
+               inventory_code: inventory_code,
+               quantity: quantity)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_type: #{@line_type}, product_code: #{@product_code}, inventory_code:"\
+      " #{@inventory_code}, quantity: #{@quantity}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line_type: #{@line_type.inspect}, product_code: #{@product_code.inspect},"\
+      " inventory_code: #{@inventory_code.inspect}, quantity: #{@quantity.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/link_customer_profile_bank_global_fund_transfer_request.rb

@@ -0,0 +1,79 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Link Customer Profile Bank Global Fund Transfer Request – Represents the
+  # data required to link a bank account to a customer profile for global fund
+  # transfer operations. Used to submit encrypted bank account information for
+  # secure linking, supporting idempotency and partner-specific logic. Inherits
+  # standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
+  class LinkCustomerProfileBankGlobalFundTransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier (UUID) used by the encryption endpoint. Should match the
+    # RequestId provided in the header.
+    # Used for idempotency and encryption.
+    # @return [String]
+    attr_accessor :salt
+
+    # Represents a container for encrypted data used in secure data transfer
+    # operations.
+    # Contains the encrypted payload and associated cryptographic metadata,
+    # including encryption version, ephemeral public key, and public key hash.
+    # Used to securely transmit sensitive information such as user data,
+    # ensuring confidentiality and integrity during transport.
+    # @return [EncryptedData]
+    attr_accessor :encrypted_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['salt'] = 'salt'
+      @_hash['encrypted_data'] = 'encryptedData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(salt:, encrypted_data:)
+      @salt = salt
+      @encrypted_data = encrypted_data
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      salt = hash.key?('salt') ? hash['salt'] : nil
+      encrypted_data = EncryptedData.from_hash(hash['encryptedData']) if hash['encryptedData']
+
+      # Create object from extracted values.
+      LinkCustomerProfileBankGlobalFundTransferRequest.new(salt: salt,
+                                                           encrypted_data: encrypted_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} salt: #{@salt}, encrypted_data: #{@encrypted_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} salt: #{@salt.inspect}, encrypted_data: #{@encrypted_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/link_customer_profile_card_global_fund_transfer_request.rb

@@ -0,0 +1,79 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Link Customer Profile Card Global Fund Transfer Request – Represents the
+  # data required to link a card to a customer profile for global fund transfer
+  # operations. Used to submit encrypted card information for secure linking,
+  # supporting idempotency and partner-specific logic. Inherits standard request
+  # metadata from Gd.Bos.DataTransfer.Request.RequestBase.
+  class LinkCustomerProfileCardGlobalFundTransferRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier (UUID) used by the encryption endpoint. Should match the
+    # RequestId provided in the header.
+    # Used for idempotency and encryption.
+    # @return [String]
+    attr_accessor :salt
+
+    # Represents a container for encrypted data used in secure data transfer
+    # operations.
+    # Contains the encrypted payload and associated cryptographic metadata,
+    # including encryption version, ephemeral public key, and public key hash.
+    # Used to securely transmit sensitive information such as user data,
+    # ensuring confidentiality and integrity during transport.
+    # @return [EncryptedData]
+    attr_accessor :encrypted_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['salt'] = 'salt'
+      @_hash['encrypted_data'] = 'encryptedData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(salt:, encrypted_data:)
+      @salt = salt
+      @encrypted_data = encrypted_data
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      salt = hash.key?('salt') ? hash['salt'] : nil
+      encrypted_data = EncryptedData.from_hash(hash['encryptedData']) if hash['encryptedData']
+
+      # Create object from extracted values.
+      LinkCustomerProfileCardGlobalFundTransferRequest.new(salt: salt,
+                                                           encrypted_data: encrypted_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} salt: #{@salt}, encrypted_data: #{@encrypted_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} salt: #{@salt.inspect}, encrypted_data: #{@encrypted_data.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/link_customer_profile_global_fund_transfer_response.rb

@@ -0,0 +1,90 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after linking a card to a customer profile
+  # for global fund transfer operations. Contains the customer profile reference
+  # and the status of the card link. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class LinkCustomerProfileGlobalFundTransferResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Global Fund Transfer Link – Represents the status and details of the link
+    # between a card and an external account for global fund transfer
+    # operations.
+    # Used to convey the link identifier, funds availability, and current status
+    # of the linked card.
+    # @return [GlobalFundTransferLink]
+    attr_accessor :link
+
+    # 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['link'] = 'link'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        link
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(link: SKIP, response_details: SKIP)
+      @link = link unless link == 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.
+      link = GlobalFundTransferLink.from_hash(hash['link']) if hash['link']
+      # 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.
+      LinkCustomerProfileGlobalFundTransferResponse.new(link: link,
+                                                        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} link: #{@link}, 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} link: #{@link.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end