apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/get_transfer_by_token_response.rb

@@ -0,0 +1,223 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned when retrieving transfer details using a
+  # unique transfer token. Provides comprehensive information about the
+  # transfer, including identifiers, status, type, amount, memo, source and
+  # target details, fees, and velocity limit status. Inherits standard response
+  # metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetTransferByTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier assigned to the transfer. Used for tracking and
+    # reference.
+    # @return [String]
+    attr_accessor :transfer_identifier
+
+    # The current status of the transfer (e.g., "pending", "completed",
+    # "failed").
+    # @return [String]
+    attr_accessor :transfer_status
+
+    # The type of transfer (e.g., "A2A", "ACH", "Wire").
+    # @return [String]
+    attr_accessor :transfer_type
+
+    # The reason for the current transfer status, if applicable (e.g.,
+    # "insufficient funds", "limit exceeded").
+    # @return [String]
+    attr_accessor :transfer_status_reason
+
+    # The amount involved in the transfer.
+    # @return [Float]
+    attr_accessor :transaction_amount
+
+    # An optional memo or note associated with the transfer.
+    # @return [String]
+    attr_accessor :memo
+
+    # Represents consumer information used as the source or target in a transfer
+    # operation.
+    # Contains account, purse, and personal details, as well as merchant and
+    # funding source information.
+    # Used to provide context about the sender or recipient in transfer-related
+    # APIs, including display and reporting.
+    # @return [Consumer]
+    attr_accessor :target_information
+
+    # Represents consumer information used as the source or target in a transfer
+    # operation.
+    # Contains account, purse, and personal details, as well as merchant and
+    # funding source information.
+    # Used to provide context about the sender or recipient in transfer-related
+    # APIs, including display and reporting.
+    # @return [Consumer]
+    attr_accessor :source_information
+
+    # A list of fees applied to the transfer, including type, amount, currency,
+    # and description.
+    # @return [Array[Fee]]
+    attr_accessor :fees
+
+    # The velocity limit status for the transfer, indicating if any transfer
+    # frequency or amount limits have been reached.
+    # @return [String]
+    attr_accessor :velocity_limit_status
+
+    # 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['transfer_identifier'] = 'transferIdentifier'
+      @_hash['transfer_status'] = 'transferStatus'
+      @_hash['transfer_type'] = 'transferType'
+      @_hash['transfer_status_reason'] = 'transferStatusReason'
+      @_hash['transaction_amount'] = 'transactionAmount'
+      @_hash['memo'] = 'memo'
+      @_hash['target_information'] = 'targetInformation'
+      @_hash['source_information'] = 'sourceInformation'
+      @_hash['fees'] = 'fees'
+      @_hash['velocity_limit_status'] = 'velocityLimitStatus'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_identifier
+        transfer_status
+        transfer_type
+        transfer_status_reason
+        transaction_amount
+        memo
+        target_information
+        source_information
+        fees
+        velocity_limit_status
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_identifier
+        transfer_status
+        transfer_type
+        transfer_status_reason
+        transaction_amount
+        memo
+        fees
+        velocity_limit_status
+        response_details
+      ]
+    end
+
+    def initialize(transfer_identifier: SKIP, transfer_status: SKIP,
+                   transfer_type: SKIP, transfer_status_reason: SKIP,
+                   transaction_amount: SKIP, memo: SKIP,
+                   target_information: SKIP, source_information: SKIP,
+                   fees: SKIP, velocity_limit_status: SKIP,
+                   response_details: SKIP)
+      @transfer_identifier = transfer_identifier unless transfer_identifier == SKIP
+      @transfer_status = transfer_status unless transfer_status == SKIP
+      @transfer_type = transfer_type unless transfer_type == SKIP
+      @transfer_status_reason = transfer_status_reason unless transfer_status_reason == SKIP
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @memo = memo unless memo == SKIP
+      @target_information = target_information unless target_information == SKIP
+      @source_information = source_information unless source_information == SKIP
+      @fees = fees unless fees == SKIP
+      @velocity_limit_status = velocity_limit_status unless velocity_limit_status == 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.
+      transfer_identifier =
+        hash.key?('transferIdentifier') ? hash['transferIdentifier'] : SKIP
+      transfer_status =
+        hash.key?('transferStatus') ? hash['transferStatus'] : SKIP
+      transfer_type = hash.key?('transferType') ? hash['transferType'] : SKIP
+      transfer_status_reason =
+        hash.key?('transferStatusReason') ? hash['transferStatusReason'] : SKIP
+      transaction_amount =
+        hash.key?('transactionAmount') ? hash['transactionAmount'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      target_information = Consumer.from_hash(hash['targetInformation']) if
+        hash['targetInformation']
+      source_information = Consumer.from_hash(hash['sourceInformation']) if
+        hash['sourceInformation']
+      # Parameter is an array, so we need to iterate through it
+      fees = nil
+      unless hash['fees'].nil?
+        fees = []
+        hash['fees'].each do |structure|
+          fees << (Fee.from_hash(structure) if structure)
+        end
+      end
+
+      fees = SKIP unless hash.key?('fees')
+      velocity_limit_status =
+        hash.key?('velocityLimitStatus') ? hash['velocityLimitStatus'] : 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.
+      GetTransferByTokenResponse.new(transfer_identifier: transfer_identifier,
+                                     transfer_status: transfer_status,
+                                     transfer_type: transfer_type,
+                                     transfer_status_reason: transfer_status_reason,
+                                     transaction_amount: transaction_amount,
+                                     memo: memo,
+                                     target_information: target_information,
+                                     source_information: source_information,
+                                     fees: fees,
+                                     velocity_limit_status: velocity_limit_status,
+                                     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} transfer_identifier: #{@transfer_identifier}, transfer_status:"\
+      " #{@transfer_status}, transfer_type: #{@transfer_type}, transfer_status_reason:"\
+      " #{@transfer_status_reason}, transaction_amount: #{@transaction_amount}, memo: #{@memo},"\
+      " target_information: #{@target_information}, source_information: #{@source_information},"\
+      " fees: #{@fees}, velocity_limit_status: #{@velocity_limit_status}, 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} transfer_identifier: #{@transfer_identifier.inspect}, transfer_status:"\
+      " #{@transfer_status.inspect}, transfer_type: #{@transfer_type.inspect},"\
+      " transfer_status_reason: #{@transfer_status_reason.inspect}, transaction_amount:"\
+      " #{@transaction_amount.inspect}, memo: #{@memo.inspect}, target_information:"\
+      " #{@target_information.inspect}, source_information: #{@source_information.inspect}, fees:"\
+      " #{@fees.inspect}, velocity_limit_status: #{@velocity_limit_status.inspect},"\
+      " response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_transfer_limits_and_fee_rates_response.rb

@@ -0,0 +1,121 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving transfer limits and fee
+  # rates for global fund transfer operations. Contains lists of transfer fee
+  # rates and transfer limits applicable to the requested program and transfer
+  # type. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetTransferLimitsAndFeeRatesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of transfer fee rates, including fixed and percentage-based fees,
+    # limits, and discounts.
+    # @return [Array[TransferFeeRates]]
+    attr_accessor :transfer_fee_rates
+
+    # List of transfer limits, including per-transfer, daily, 7-day, and 30-day
+    # limits.
+    # @return [Array[TransferLimits]]
+    attr_accessor :transfer_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['transfer_fee_rates'] = 'transferFeeRates'
+      @_hash['transfer_limits'] = 'transferLimits'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_fee_rates
+        transfer_limits
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_fee_rates
+        transfer_limits
+        response_details
+      ]
+    end
+
+    def initialize(transfer_fee_rates: SKIP, transfer_limits: SKIP,
+                   response_details: SKIP)
+      @transfer_fee_rates = transfer_fee_rates unless transfer_fee_rates == SKIP
+      @transfer_limits = transfer_limits unless transfer_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
+      transfer_fee_rates = nil
+      unless hash['transferFeeRates'].nil?
+        transfer_fee_rates = []
+        hash['transferFeeRates'].each do |structure|
+          transfer_fee_rates << (TransferFeeRates.from_hash(structure) if structure)
+        end
+      end
+
+      transfer_fee_rates = SKIP unless hash.key?('transferFeeRates')
+      # Parameter is an array, so we need to iterate through it
+      transfer_limits = nil
+      unless hash['transferLimits'].nil?
+        transfer_limits = []
+        hash['transferLimits'].each do |structure|
+          transfer_limits << (TransferLimits.from_hash(structure) if structure)
+        end
+      end
+
+      transfer_limits = SKIP unless hash.key?('transferLimits')
+      # 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.
+      GetTransferLimitsAndFeeRatesResponse.new(transfer_fee_rates: transfer_fee_rates,
+                                               transfer_limits: transfer_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} transfer_fee_rates: #{@transfer_fee_rates}, transfer_limits:"\
+      " #{@transfer_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} transfer_fee_rates: #{@transfer_fee_rates.inspect}, transfer_limits:"\
+      " #{@transfer_limits.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_transfer_response.rb

@@ -0,0 +1,115 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned when retrieving details of a Green Dot
+  # Funds Transfer (GFT) operation. Contains comprehensive information about the
+  # transfer, including status, amounts, processor/network details, and any
+  # associated network response codes. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetTransferResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents the details of a Green Dot Funds Transfer (GFT) operation.
+    # Contains comprehensive information about the transfer, including
+    # identifiers, status, transaction and fee amounts, processor and network
+    # details, and a breakdown of applied fees.
+    # Used in transfer-related responses to provide a complete view of the
+    # transfer's outcome, financials, and processing context.
+    # @return [GftTransfer]
+    attr_accessor :transfer
+
+    # Represents the network response details for a Green Dot Funds Transfer
+    # (GFT) operation.
+    # Contains information about the payment processor and network status,
+    # including processor code, network status code, and a human-readable status
+    # description.
+    # Used to provide additional context about the outcome of a transfer as
+    # reported by external payment networks or processors.
+    # @return [TransferNetworkResponse]
+    attr_accessor :transfer_network_response
+
+    # 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['transfer'] = 'transfer'
+      @_hash['transfer_network_response'] = 'transferNetworkResponse'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer
+        transfer_network_response
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(transfer: SKIP, transfer_network_response: SKIP,
+                   response_details: SKIP)
+      @transfer = transfer unless transfer == SKIP
+      unless transfer_network_response == SKIP
+        @transfer_network_response =
+          transfer_network_response
+      end
+      @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.
+      transfer = GftTransfer.from_hash(hash['transfer']) if hash['transfer']
+      if hash['transferNetworkResponse']
+        transfer_network_response = TransferNetworkResponse.from_hash(hash['transferNetworkResponse'])
+      end
+      # 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.
+      GetTransferResponse.new(transfer: transfer,
+                              transfer_network_response: transfer_network_response,
+                              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} transfer: #{@transfer}, transfer_network_response:"\
+      " #{@transfer_network_response}, 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} transfer: #{@transfer.inspect}, transfer_network_response:"\
+      " #{@transfer_network_response.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_transfer_status_response.rb

@@ -0,0 +1,93 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Get Transfer Status Response – Contains the status and details of a specific
+  # transfer. Used to provide transaction details for a given transfer
+  # identifier.
+  class GetTransferStatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Disbursement Transaction Detail – Represents detailed information about a
+    # disbursement transaction.
+    # Used to provide transaction attributes such as identifiers, status, claim
+    # code, original transaction codes, source and destination entities, and
+    # additional options in transfer status and history responses.
+    # Inherits common transaction properties from
+    # Gd.Bos.DataTransfer.Response.ResponseObjects.DisbursementTransferInfo.
+    # @return [DisbursementTransactionDetail]
+    attr_accessor :transaction
+
+    # 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['transaction'] = 'transaction'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(transaction: SKIP, response_details: SKIP)
+      @transaction = transaction unless transaction == 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.
+      transaction = DisbursementTransactionDetail.from_hash(hash['transaction']) if
+        hash['transaction']
+      # 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.
+      GetTransferStatusResponse.new(transaction: transaction,
+                                    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} transaction: #{@transaction}, 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} transaction: #{@transaction.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/get_user_category_summary_response.rb

@@ -0,0 +1,111 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after retrieving a summary of
+  # user-categorized transactions. Contains a list of user categories and the
+  # total amount for all categorized transactions. Inherits standard response
+  # metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class GetUserCategorySummaryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of user categories, each summarizing transactions by user-defined
+    # category.
+    # Each Gd.Bos.DataTransfer.TransactionUserCategory includes category details
+    # and associated transaction data.
+    # @return [Array[TransactionUserCategory]]
+    attr_accessor :user_categories
+
+    # The total amount for all categorized transactions in the summary.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # 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['user_categories'] = 'userCategories'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_categories
+        total_amount
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        user_categories
+        response_details
+      ]
+    end
+
+    def initialize(user_categories: SKIP, total_amount: SKIP,
+                   response_details: SKIP)
+      @user_categories = user_categories unless user_categories == SKIP
+      @total_amount = total_amount unless total_amount == 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
+      user_categories = nil
+      unless hash['userCategories'].nil?
+        user_categories = []
+        hash['userCategories'].each do |structure|
+          user_categories << (TransactionUserCategory.from_hash(structure) if structure)
+        end
+      end
+
+      user_categories = SKIP unless hash.key?('userCategories')
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : 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.
+      GetUserCategorySummaryResponse.new(user_categories: user_categories,
+                                         total_amount: total_amount,
+                                         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} user_categories: #{@user_categories}, total_amount: #{@total_amount},"\
+      " 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} user_categories: #{@user_categories.inspect}, total_amount:"\
+      " #{@total_amount.inspect}, response_details: #{@response_details.inspect}>"
+    end
+  end
+end