apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/update_amm_rule_priority_request.rb

@@ -0,0 +1,74 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a request to update the priorities of Automated Money Movement
+  # (AMM) rules for an account. Contains the source account identifier and a
+  # list of rule priorities to update. Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class UpdateAmmRulePriorityRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of AMM rule priorities to update.
+    # Each Gd.Bos.DataTransfer.AMMRulePriority includes the rule ID and the new
+    # priority value.
+    # @return [Array[AmmRulePriority]]
+    attr_accessor :rule_priorities
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rule_priorities'] = 'rulePriorities'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rule_priorities:)
+      @rule_priorities = rule_priorities
+    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
+      rule_priorities = nil
+      unless hash['rulePriorities'].nil?
+        rule_priorities = []
+        hash['rulePriorities'].each do |structure|
+          rule_priorities << (AmmRulePriority.from_hash(structure) if structure)
+        end
+      end
+
+      rule_priorities = nil unless hash.key?('rulePriorities')
+
+      # Create object from extracted values.
+      UpdateAmmRulePriorityRequest.new(rule_priorities: rule_priorities)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_priorities: #{@rule_priorities}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_priorities: #{@rule_priorities.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_amm_rule_priority_response.rb

@@ -0,0 +1,77 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after updating the priority of an Automated
+  # Money Movement (AMM) rule. Used to indicate the outcome of an AMM rule
+  # priority update operation. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class UpdateAmmRulePriorityResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(response_details: 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
+      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.
+      UpdateAmmRulePriorityResponse.new(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} 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} response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_amm_rule_request.rb

@@ -0,0 +1,179 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents a request to update an Automated Money Movement (AMM) rule.
+  # Contains identifiers, scheduling, transfer details, and configuration for
+  # the AMM rule to be updated. Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class UpdateAmmRuleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the AMM rule to update.
+    # @return [Integer]
+    attr_accessor :rule_id
+
+    # The name assigned to the AMM rule.
+    # @return [String]
+    attr_accessor :amm_rule_name
+
+    # The start date when the rule becomes active.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date when the rule expires or is deactivated.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The maximum cap amount for transfers under this rule.
+    # @return [Float]
+    attr_accessor :max_cap_amount
+
+    # The priority of the rule for execution order.
+    # @return [Integer]
+    attr_accessor :rule_priority
+
+    # The fixed transfer amount for each execution of the rule.
+    # @return [Float]
+    attr_accessor :fixed_transfer_amount
+
+    # The percentage of the qualifying amount to transfer.
+    # @return [Float]
+    attr_accessor :transfer_percentage
+
+    # The scheduled day for rule execution (e.g., day of month).
+    # @return [Integer]
+    attr_accessor :schedule_day
+
+    # The frequency type of the rule (e.g., "Daily", "Weekly", "Monthly").
+    # @return [String]
+    attr_accessor :rule_frequency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rule_id'] = 'ruleID'
+      @_hash['amm_rule_name'] = 'ammRuleName'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['max_cap_amount'] = 'maxCapAmount'
+      @_hash['rule_priority'] = 'rulePriority'
+      @_hash['fixed_transfer_amount'] = 'fixedTransferAmount'
+      @_hash['transfer_percentage'] = 'transferPercentage'
+      @_hash['schedule_day'] = 'scheduleDay'
+      @_hash['rule_frequency'] = 'ruleFrequency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amm_rule_name
+        start_date
+        end_date
+        max_cap_amount
+        rule_priority
+        fixed_transfer_amount
+        transfer_percentage
+        schedule_day
+        rule_frequency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amm_rule_name
+        rule_frequency
+      ]
+    end
+
+    def initialize(rule_id:, amm_rule_name: SKIP, start_date: SKIP,
+                   end_date: SKIP, max_cap_amount: SKIP, rule_priority: SKIP,
+                   fixed_transfer_amount: SKIP, transfer_percentage: SKIP,
+                   schedule_day: SKIP, rule_frequency: SKIP)
+      @rule_id = rule_id
+      @amm_rule_name = amm_rule_name unless amm_rule_name == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @max_cap_amount = max_cap_amount unless max_cap_amount == SKIP
+      @rule_priority = rule_priority unless rule_priority == SKIP
+      @fixed_transfer_amount = fixed_transfer_amount unless fixed_transfer_amount == SKIP
+      @transfer_percentage = transfer_percentage unless transfer_percentage == SKIP
+      @schedule_day = schedule_day unless schedule_day == SKIP
+      @rule_frequency = rule_frequency unless rule_frequency == 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.
+      rule_id = hash.key?('ruleID') ? hash['ruleID'] : nil
+      amm_rule_name = hash.key?('ammRuleName') ? hash['ammRuleName'] : SKIP
+      start_date = if hash.key?('startDate')
+                     (DateTimeHelper.from_rfc3339(hash['startDate']) if hash['startDate'])
+                   else
+                     SKIP
+                   end
+      end_date = if hash.key?('endDate')
+                   (DateTimeHelper.from_rfc3339(hash['endDate']) if hash['endDate'])
+                 else
+                   SKIP
+                 end
+      max_cap_amount = hash.key?('maxCapAmount') ? hash['maxCapAmount'] : SKIP
+      rule_priority = hash.key?('rulePriority') ? hash['rulePriority'] : SKIP
+      fixed_transfer_amount =
+        hash.key?('fixedTransferAmount') ? hash['fixedTransferAmount'] : SKIP
+      transfer_percentage =
+        hash.key?('transferPercentage') ? hash['transferPercentage'] : SKIP
+      schedule_day = hash.key?('scheduleDay') ? hash['scheduleDay'] : SKIP
+      rule_frequency = hash.key?('ruleFrequency') ? hash['ruleFrequency'] : SKIP
+
+      # Create object from extracted values.
+      UpdateAmmRuleRequest.new(rule_id: rule_id,
+                               amm_rule_name: amm_rule_name,
+                               start_date: start_date,
+                               end_date: end_date,
+                               max_cap_amount: max_cap_amount,
+                               rule_priority: rule_priority,
+                               fixed_transfer_amount: fixed_transfer_amount,
+                               transfer_percentage: transfer_percentage,
+                               schedule_day: schedule_day,
+                               rule_frequency: rule_frequency)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_id: #{@rule_id}, amm_rule_name: #{@amm_rule_name}, start_date:"\
+      " #{@start_date}, end_date: #{@end_date}, max_cap_amount: #{@max_cap_amount}, rule_priority:"\
+      " #{@rule_priority}, fixed_transfer_amount: #{@fixed_transfer_amount}, transfer_percentage:"\
+      " #{@transfer_percentage}, schedule_day: #{@schedule_day}, rule_frequency:"\
+      " #{@rule_frequency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_id: #{@rule_id.inspect}, amm_rule_name: #{@amm_rule_name.inspect},"\
+      " start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect}, max_cap_amount:"\
+      " #{@max_cap_amount.inspect}, rule_priority: #{@rule_priority.inspect},"\
+      " fixed_transfer_amount: #{@fixed_transfer_amount.inspect}, transfer_percentage:"\
+      " #{@transfer_percentage.inspect}, schedule_day: #{@schedule_day.inspect}, rule_frequency:"\
+      " #{@rule_frequency.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_amm_rule_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 updating an Automated Money Movement
+  # (AMM) rule. Contains the updated AMM rule details. Inherits standard
+  # response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
+  class UpdateAmmRuleResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents an Automated Money Movement (AMM) rule configuration.
+    # Contains identifiers, scheduling, transfer details, merchant categories,
+    # and associated transactions.
+    # Used to define, manage, and execute automated money movement rules for
+    # accounts.
+    # @return [AmmRule]
+    attr_accessor :updated_rule
+
+    # 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['updated_rule'] = 'updatedRule'
+      @_hash['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        updated_rule
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(updated_rule: SKIP, response_details: SKIP)
+      @updated_rule = updated_rule unless updated_rule == 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.
+      updated_rule = AmmRule.from_hash(hash['updatedRule']) if hash['updatedRule']
+      # 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.
+      UpdateAmmRuleResponse.new(updated_rule: updated_rule,
+                                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} updated_rule: #{@updated_rule}, 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} updated_rule: #{@updated_rule.inspect}, response_details:"\
+      " #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_amm_rule_status_request.rb

@@ -0,0 +1,89 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module GdBosV1
+  # Represents a request to update the status of an Automated Money Movement
+  # (AMM) rule. Contains the source account identifier, rule ID, new status, and
+  # optional end date. Inherits standard request metadata from
+  # Gd.Bos.DataTransfer.Request.RequestBase.
+  class UpdateAmmRuleStatusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The new status to set for the AMM rule (e.g., Active, Inactive, Expiring,
+    # Completed, Paused).
+    # Uses Gd.Bos.DataTransfer.Enums.AMMRuleStatus to specify the rule status.
+    # @return [RuleStatus]
+    attr_accessor :rule_status
+
+    # The end date for the AMM rule, if applicable.
+    # Used when expiring or completing a rule.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rule_status'] = 'ruleStatus'
+      @_hash['end_date'] = 'endDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        rule_status
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        rule_status
+        end_date
+      ]
+    end
+
+    def initialize(rule_status: SKIP, end_date: SKIP)
+      @rule_status = rule_status unless rule_status == SKIP
+      @end_date = end_date unless end_date == 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.
+      rule_status = hash.key?('ruleStatus') ? hash['ruleStatus'] : SKIP
+      end_date = if hash.key?('endDate')
+                   (DateTimeHelper.from_rfc3339(hash['endDate']) if hash['endDate'])
+                 else
+                   SKIP
+                 end
+
+      # Create object from extracted values.
+      UpdateAmmRuleStatusRequest.new(rule_status: rule_status,
+                                     end_date: end_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_status: #{@rule_status}, end_date: #{@end_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rule_status: #{@rule_status.inspect}, end_date: #{@end_date.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_amm_rule_status_response.rb

@@ -0,0 +1,77 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the response returned after updating the status of an Automated
+  # Money Movement (AMM) rule. Used to indicate the outcome of an AMM rule
+  # status update operation. Inherits standard response metadata from
+  # Gd.Bos.DataTransfer.Response.ResponseBase.
+  class UpdateAmmRuleStatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['response_details'] = 'responseDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        response_details
+      ]
+    end
+
+    def initialize(response_details: 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
+      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.
+      UpdateAmmRuleStatusResponse.new(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} 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} response_details: #{@response_details.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/update_bank_link_request.rb

@@ -0,0 +1,79 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Update Bank Link Request – Represents the data required to update a linked
+  # bank account for a customer profile in global fund transfer operations. Used
+  # to submit encrypted bank account information for secure updates, supporting
+  # idempotency and partner-specific logic. Inherits standard request metadata
+  # from Gd.Bos.DataTransfer.Request.RequestBase.
+  class UpdateBankLinkRequest < 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.
+      UpdateBankLinkRequest.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