apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/partner_by_location_data.rb

@@ -0,0 +1,129 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Partner By Location Data – Represents information about an eCash partner
+  # (retailer) found by location search. Used to provide partner and retailer
+  # details, including identifiers, names, face fee, retailer code, and display
+  # priority in location-based partner search responses.
+  class PartnerByLocationData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the eCash partner (retailer).
+    # @return [String]
+    attr_accessor :partner_id
+
+    # The display name of the eCash partner (retailer).
+    # @return [String]
+    attr_accessor :partner_name
+
+    # The face fee (as a string, e.g., "3.95") associated with transactions at
+    # this partner location.
+    # @return [String]
+    attr_accessor :face_fee
+
+    # The unique code assigned to the retailer location.
+    # @return [String]
+    attr_accessor :retailer_code
+
+    # The display name of the retailer location.
+    # @return [String]
+    attr_accessor :retailer_name
+
+    # The display priority for the retailer in search results (lower values
+    # indicate higher priority).
+    # @return [Integer]
+    attr_accessor :retailer_display_priority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['partner_id'] = 'partnerId'
+      @_hash['partner_name'] = 'partnerName'
+      @_hash['face_fee'] = 'faceFee'
+      @_hash['retailer_code'] = 'retailerCode'
+      @_hash['retailer_name'] = 'retailerName'
+      @_hash['retailer_display_priority'] = 'retailerDisplayPriority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        partner_id
+        partner_name
+        face_fee
+        retailer_code
+        retailer_name
+        retailer_display_priority
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        partner_id
+        partner_name
+        face_fee
+        retailer_code
+        retailer_name
+      ]
+    end
+
+    def initialize(partner_id: SKIP, partner_name: SKIP, face_fee: SKIP,
+                   retailer_code: SKIP, retailer_name: SKIP,
+                   retailer_display_priority: SKIP)
+      @partner_id = partner_id unless partner_id == SKIP
+      @partner_name = partner_name unless partner_name == SKIP
+      @face_fee = face_fee unless face_fee == SKIP
+      @retailer_code = retailer_code unless retailer_code == SKIP
+      @retailer_name = retailer_name unless retailer_name == SKIP
+      unless retailer_display_priority == SKIP
+        @retailer_display_priority =
+          retailer_display_priority
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      partner_id = hash.key?('partnerId') ? hash['partnerId'] : SKIP
+      partner_name = hash.key?('partnerName') ? hash['partnerName'] : SKIP
+      face_fee = hash.key?('faceFee') ? hash['faceFee'] : SKIP
+      retailer_code = hash.key?('retailerCode') ? hash['retailerCode'] : SKIP
+      retailer_name = hash.key?('retailerName') ? hash['retailerName'] : SKIP
+      retailer_display_priority =
+        hash.key?('retailerDisplayPriority') ? hash['retailerDisplayPriority'] : SKIP
+
+      # Create object from extracted values.
+      PartnerByLocationData.new(partner_id: partner_id,
+                                partner_name: partner_name,
+                                face_fee: face_fee,
+                                retailer_code: retailer_code,
+                                retailer_name: retailer_name,
+                                retailer_display_priority: retailer_display_priority)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} partner_id: #{@partner_id}, partner_name: #{@partner_name}, face_fee:"\
+      " #{@face_fee}, retailer_code: #{@retailer_code}, retailer_name: #{@retailer_name},"\
+      " retailer_display_priority: #{@retailer_display_priority}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} partner_id: #{@partner_id.inspect}, partner_name: #{@partner_name.inspect},"\
+      " face_fee: #{@face_fee.inspect}, retailer_code: #{@retailer_code.inspect}, retailer_name:"\
+      " #{@retailer_name.inspect}, retailer_display_priority:"\
+      " #{@retailer_display_priority.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/payee.rb

@@ -0,0 +1,164 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Payee – Represents a payee entity returned in payee search results. Used to
+  # provide details about a merchant or person payee, including name, merchant
+  # information, address, and contact details.
+  class Payee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the payee (merchant or person).
+    # @return [String]
+    attr_accessor :name
+
+    # The unique merchant identifier for merchant payees.
+    # Null or empty for person payees.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Indicates whether the merchant requires a ZIP code for bill payments.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :merchant_zip_required
+
+    # The first line of the payee's address.
+    # @return [String]
+    attr_accessor :address1
+
+    # The second line of the payee's address (optional).
+    # @return [String]
+    attr_accessor :address2
+
+    # The city of the payee's address.
+    # @return [String]
+    attr_accessor :city
+
+    # The state or province of the payee's address.
+    # @return [String]
+    attr_accessor :state
+
+    # The country of the payee's address (e.g., "US").
+    # @return [String]
+    attr_accessor :country
+
+    # The ZIP or postal code of the payee's address.
+    # @return [String]
+    attr_accessor :zip
+
+    # The payee's phone number.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['merchant_id'] = 'merchantId'
+      @_hash['merchant_zip_required'] = 'merchantZipRequired'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country'] = 'country'
+      @_hash['zip'] = 'zip'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        merchant_id
+        merchant_zip_required
+        address1
+        address2
+        city
+        state
+        country
+        zip
+        phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        name
+        merchant_id
+        address1
+        address2
+        city
+        state
+        country
+        zip
+        phone_number
+      ]
+    end
+
+    def initialize(name: SKIP, merchant_id: SKIP, merchant_zip_required: SKIP,
+                   address1: SKIP, address2: SKIP, city: SKIP, state: SKIP,
+                   country: SKIP, zip: SKIP, phone_number: SKIP)
+      @name = name unless name == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @merchant_zip_required = merchant_zip_required unless merchant_zip_required == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @country = country unless country == SKIP
+      @zip = zip unless zip == SKIP
+      @phone_number = phone_number unless phone_number == 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
+      merchant_id = hash.key?('merchantId') ? hash['merchantId'] : SKIP
+      merchant_zip_required =
+        hash.key?('merchantZipRequired') ? hash['merchantZipRequired'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+
+      # Create object from extracted values.
+      Payee.new(name: name,
+                merchant_id: merchant_id,
+                merchant_zip_required: merchant_zip_required,
+                address1: address1,
+                address2: address2,
+                city: city,
+                state: state,
+                country: country,
+                zip: zip,
+                phone_number: phone_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, merchant_id: #{@merchant_id}, merchant_zip_required:"\
+      " #{@merchant_zip_required}, address1: #{@address1}, address2: #{@address2}, city: #{@city},"\
+      " state: #{@state}, country: #{@country}, zip: #{@zip}, phone_number: #{@phone_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_zip_required: #{@merchant_zip_required.inspect}, address1: #{@address1.inspect},"\
+      " address2: #{@address2.inspect}, city: #{@city.inspect}, state: #{@state.inspect}, country:"\
+      " #{@country.inspect}, zip: #{@zip.inspect}, phone_number: #{@phone_number.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/payee_detail.rb

@@ -0,0 +1,212 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Payee Detail – Represents detailed information about a bill payee associated
+  # with an account. Used to provide payee attributes such as identifier,
+  # status, type, name, address, and contact information in payee list and
+  # detail responses.
+  class PayeeDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier assigned to the payee.
+    # @return [String]
+    attr_accessor :payee_identifier
+
+    # The status of the payee (e.g., Active, Inactive).
+    # See Gd.Bos.DataTransfer.PayeeDetail.PayeeStatus.
+    # @return [PayeeStatus1]
+    attr_accessor :payee_status
+
+    # The type of payee (e.g., Merchant, Person).
+    # See Gd.Bos.DataTransfer.PayeeDetail.PayeeType.
+    # @return [PayeeType]
+    attr_accessor :payee_type
+
+    # The name of the payee (merchant or person).
+    # @return [String]
+    attr_accessor :name
+
+    # An optional nickname for the payee.
+    # @return [String]
+    attr_accessor :nick_name
+
+    # The first line of the payee's address.
+    # @return [String]
+    attr_accessor :address1
+
+    # The second line of the payee's address (optional).
+    # @return [String]
+    attr_accessor :address2
+
+    # The city of the payee's address.
+    # @return [String]
+    attr_accessor :city
+
+    # The state or province of the payee's address.
+    # @return [String]
+    attr_accessor :state
+
+    # The ZIP or postal code of the payee's address.
+    # @return [String]
+    attr_accessor :zip
+
+    # The country of the payee's address (e.g., "US").
+    # @return [String]
+    attr_accessor :country
+
+    # The account number associated with the payee, if applicable.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The payee's phone number.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The payee's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payee_identifier'] = 'payeeIdentifier'
+      @_hash['payee_status'] = 'payeeStatus'
+      @_hash['payee_type'] = 'payeeType'
+      @_hash['name'] = 'name'
+      @_hash['nick_name'] = 'nickName'
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payee_identifier
+        payee_status
+        payee_type
+        name
+        nick_name
+        address1
+        address2
+        city
+        state
+        zip
+        country
+        account_number
+        phone_number
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payee_identifier
+        payee_status
+        payee_type
+        name
+        nick_name
+        address1
+        address2
+        city
+        state
+        zip
+        country
+        account_number
+        phone_number
+        email
+      ]
+    end
+
+    def initialize(payee_identifier: SKIP, payee_status: SKIP, payee_type: SKIP,
+                   name: SKIP, nick_name: SKIP, address1: SKIP, address2: SKIP,
+                   city: SKIP, state: SKIP, zip: SKIP, country: SKIP,
+                   account_number: SKIP, phone_number: SKIP, email: SKIP)
+      @payee_identifier = payee_identifier unless payee_identifier == SKIP
+      @payee_status = payee_status unless payee_status == SKIP
+      @payee_type = payee_type unless payee_type == SKIP
+      @name = name unless name == SKIP
+      @nick_name = nick_name unless nick_name == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email = email unless email == 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.
+      payee_identifier =
+        hash.key?('payeeIdentifier') ? hash['payeeIdentifier'] : SKIP
+      payee_status = hash.key?('payeeStatus') ? hash['payeeStatus'] : SKIP
+      payee_type = hash.key?('payeeType') ? hash['payeeType'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      nick_name = hash.key?('nickName') ? hash['nickName'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : 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
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+
+      # Create object from extracted values.
+      PayeeDetail.new(payee_identifier: payee_identifier,
+                      payee_status: payee_status,
+                      payee_type: payee_type,
+                      name: name,
+                      nick_name: nick_name,
+                      address1: address1,
+                      address2: address2,
+                      city: city,
+                      state: state,
+                      zip: zip,
+                      country: country,
+                      account_number: account_number,
+                      phone_number: phone_number,
+                      email: email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_identifier: #{@payee_identifier}, payee_status: #{@payee_status},"\
+      " payee_type: #{@payee_type}, name: #{@name}, nick_name: #{@nick_name}, address1:"\
+      " #{@address1}, address2: #{@address2}, city: #{@city}, state: #{@state}, zip: #{@zip},"\
+      " country: #{@country}, account_number: #{@account_number}, phone_number: #{@phone_number},"\
+      " email: #{@email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payee_identifier: #{@payee_identifier.inspect}, payee_status:"\
+      " #{@payee_status.inspect}, payee_type: #{@payee_type.inspect}, name: #{@name.inspect},"\
+      " nick_name: #{@nick_name.inspect}, address1: #{@address1.inspect}, address2:"\
+      " #{@address2.inspect}, city: #{@city.inspect}, state: #{@state.inspect}, zip:"\
+      " #{@zip.inspect}, country: #{@country.inspect}, account_number: #{@account_number.inspect},"\
+      " phone_number: #{@phone_number.inspect}, email: #{@email.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/payee_status.rb

@@ -0,0 +1,38 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # The status of the payee after creation. Possible values are defined in
+  # Gd.Bos.DataTransfer.Response.CreatePayeeResponse.PayeeStatus (e.g., Active,
+  # Inactive).
+  class PayeeStatus
+    PAYEE_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'inactive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/gd_bos_v1/models/payee_status1.rb

@@ -0,0 +1,37 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # The status of the payee (e.g., Active, Inactive). See
+  # Gd.Bos.DataTransfer.PayeeDetail.PayeeStatus.
+  class PayeeStatus1
+    PAYEE_STATUS1 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'inactive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/gd_bos_v1/models/payee_type.rb

@@ -0,0 +1,37 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # The type of payee (e.g., Merchant, Person). See
+  # Gd.Bos.DataTransfer.PayeeDetail.PayeeType.
+  class PayeeType
+    PAYEE_TYPE = [
+      # TODO: Write general description for PERSON
+      PERSON = 'person'.freeze,
+
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'merchant'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PERSON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'person' then PERSON
+      when 'merchant' then MERCHANT
+      else
+        default_value
+      end
+    end
+  end
+end