apimatic-greendot-sdk 0.0.1

data/lib/gd_bos_v1/models/payment_instrument_token.rb

@@ -0,0 +1,179 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Container for data related to provisioning token
+  class PaymentInstrumentToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of a card number
+    # @return [String]
+    attr_accessor :payment_identifier
+
+    # Device Id
+    # @return [String]
+    attr_accessor :device_id
+
+    # Last 4 digits of the card number
+    # @return [String]
+    attr_accessor :last4_pan
+
+    # Network proxy representation of a digital card number. Will be unique to a
+    # device
+    # @return [String]
+    attr_accessor :dpanid
+
+    # Network proxy representation of a payment identifier. Will be consistent
+    # across devices
+    # @return [String]
+    attr_accessor :fpanid
+
+    # Network proxy representation of an account. Will be consistent across
+    # payment identifiers
+    # @return [String]
+    attr_accessor :par
+
+    # Last 4 digits of a digital card number
+    # @return [String]
+    attr_accessor :last4_dpan
+
+    # Digital wallet the payment identifier is provisioned into
+    # @return [String]
+    attr_accessor :wallet
+
+    # The type of wallet
+    # @return [String]
+    attr_accessor :wallet_type
+
+    # Status of the digital card number
+    # @return [String]
+    attr_accessor :status
+
+    # payment network the card belongs to
+    # @return [String]
+    attr_accessor :payment_network_operator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_identifier'] = 'paymentIdentifier'
+      @_hash['device_id'] = 'deviceId'
+      @_hash['last4_pan'] = 'last4Pan'
+      @_hash['dpanid'] = 'DPANID'
+      @_hash['fpanid'] = 'FPANID'
+      @_hash['par'] = 'PAR'
+      @_hash['last4_dpan'] = 'last4DPAN'
+      @_hash['wallet'] = 'wallet'
+      @_hash['wallet_type'] = 'walletType'
+      @_hash['status'] = 'status'
+      @_hash['payment_network_operator'] = 'paymentNetworkOperator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_identifier
+        device_id
+        last4_pan
+        dpanid
+        fpanid
+        par
+        last4_dpan
+        wallet
+        wallet_type
+        status
+        payment_network_operator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payment_identifier
+        device_id
+        last4_pan
+        dpanid
+        fpanid
+        par
+        last4_dpan
+        wallet
+        wallet_type
+        status
+        payment_network_operator
+      ]
+    end
+
+    def initialize(payment_identifier: SKIP, device_id: SKIP, last4_pan: SKIP,
+                   dpanid: SKIP, fpanid: SKIP, par: SKIP, last4_dpan: SKIP,
+                   wallet: SKIP, wallet_type: SKIP, status: SKIP,
+                   payment_network_operator: SKIP)
+      @payment_identifier = payment_identifier unless payment_identifier == SKIP
+      @device_id = device_id unless device_id == SKIP
+      @last4_pan = last4_pan unless last4_pan == SKIP
+      @dpanid = dpanid unless dpanid == SKIP
+      @fpanid = fpanid unless fpanid == SKIP
+      @par = par unless par == SKIP
+      @last4_dpan = last4_dpan unless last4_dpan == SKIP
+      @wallet = wallet unless wallet == SKIP
+      @wallet_type = wallet_type unless wallet_type == SKIP
+      @status = status unless status == SKIP
+      @payment_network_operator = payment_network_operator unless payment_network_operator == 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.
+      payment_identifier =
+        hash.key?('paymentIdentifier') ? hash['paymentIdentifier'] : SKIP
+      device_id = hash.key?('deviceId') ? hash['deviceId'] : SKIP
+      last4_pan = hash.key?('last4Pan') ? hash['last4Pan'] : SKIP
+      dpanid = hash.key?('DPANID') ? hash['DPANID'] : SKIP
+      fpanid = hash.key?('FPANID') ? hash['FPANID'] : SKIP
+      par = hash.key?('PAR') ? hash['PAR'] : SKIP
+      last4_dpan = hash.key?('last4DPAN') ? hash['last4DPAN'] : SKIP
+      wallet = hash.key?('wallet') ? hash['wallet'] : SKIP
+      wallet_type = hash.key?('walletType') ? hash['walletType'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      payment_network_operator =
+        hash.key?('paymentNetworkOperator') ? hash['paymentNetworkOperator'] : SKIP
+
+      # Create object from extracted values.
+      PaymentInstrumentToken.new(payment_identifier: payment_identifier,
+                                 device_id: device_id,
+                                 last4_pan: last4_pan,
+                                 dpanid: dpanid,
+                                 fpanid: fpanid,
+                                 par: par,
+                                 last4_dpan: last4_dpan,
+                                 wallet: wallet,
+                                 wallet_type: wallet_type,
+                                 status: status,
+                                 payment_network_operator: payment_network_operator)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_identifier: #{@payment_identifier}, device_id: #{@device_id},"\
+      " last4_pan: #{@last4_pan}, dpanid: #{@dpanid}, fpanid: #{@fpanid}, par: #{@par},"\
+      " last4_dpan: #{@last4_dpan}, wallet: #{@wallet}, wallet_type: #{@wallet_type}, status:"\
+      " #{@status}, payment_network_operator: #{@payment_network_operator}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_identifier: #{@payment_identifier.inspect}, device_id:"\
+      " #{@device_id.inspect}, last4_pan: #{@last4_pan.inspect}, dpanid: #{@dpanid.inspect},"\
+      " fpanid: #{@fpanid.inspect}, par: #{@par.inspect}, last4_dpan: #{@last4_dpan.inspect},"\
+      " wallet: #{@wallet.inspect}, wallet_type: #{@wallet_type.inspect}, status:"\
+      " #{@status.inspect}, payment_network_operator: #{@payment_network_operator.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/payment_status.rb

@@ -0,0 +1,53 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # The status of the payment (e.g., Scheduled, Canceled, Failed, InProcess,
+  # Processed, UnApproved). See Gd.Bos.DataTransfer.Payment.PaymentStatus.
+  class PaymentStatus
+    PAYMENT_STATUS = [
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'scheduled'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for INPROCESS
+      INPROCESS = 'inprocess'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'processed'.freeze,
+
+      # TODO: Write general description for UNAPPROVED
+      UNAPPROVED = 'unapproved'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SCHEDULED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'scheduled' then SCHEDULED
+      when 'canceled' then CANCELED
+      when 'failed' then FAILED
+      when 'inprocess' then INPROCESS
+      when 'processed' then PROCESSED
+      when 'unapproved' then UNAPPROVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/gd_bos_v1/models/payment_status_detail.rb

@@ -0,0 +1,204 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents the status details of a single purchase transaction. Contains
+  # transaction identifiers, amounts, approval codes, action codes, and
+  # additional metadata.
+  class PaymentStatusDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of message returned for the payment status (e.g.,
+    # "Authorization", "Advice").
+    # @return [String]
+    attr_accessor :message_type
+
+    # The identifier of the payment instrument used for the transaction (e.g.,
+    # card or account number).
+    # @return [String]
+    attr_accessor :payment_instrument_identifier
+
+    # The unique identifier for the payment transaction.
+    # @return [String]
+    attr_accessor :transaction_identifier
+
+    # The system trace number for the transaction, used for tracking and
+    # reconciliation.
+    # @return [String]
+    attr_accessor :system_trace_number
+
+    # The retrieval reference number for the transaction, used for audit and
+    # dispute purposes.
+    # @return [String]
+    attr_accessor :retrieval_reference_number
+
+    # The authorized transaction amount.
+    # @return [Float]
+    attr_accessor :transaction_amount
+
+    # The currency code for the transaction (e.g., "USD", "EUR").
+    # @return [String]
+    attr_accessor :transaction_currency
+
+    # The approval code returned by the payment network or processor.
+    # @return [String]
+    attr_accessor :approval_code
+
+    # The action code indicating the result of the transaction (e.g., "00" for
+    # approved, "05" for declined).
+    # @return [String]
+    attr_accessor :action_code
+
+    # The reason for the action code, providing additional context for the
+    # transaction result.
+    # @return [String]
+    attr_accessor :action_reason
+
+    # Any additional amount authorized or related to the transaction (e.g.,
+    # cashback).
+    # @return [Float]
+    attr_accessor :additional_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_type'] = 'messageType'
+      @_hash['payment_instrument_identifier'] = 'paymentInstrumentIdentifier'
+      @_hash['transaction_identifier'] = 'transactionIdentifier'
+      @_hash['system_trace_number'] = 'systemTraceNumber'
+      @_hash['retrieval_reference_number'] = 'retrievalReferenceNumber'
+      @_hash['transaction_amount'] = 'transactionAmount'
+      @_hash['transaction_currency'] = 'transactionCurrency'
+      @_hash['approval_code'] = 'approvalCode'
+      @_hash['action_code'] = 'actionCode'
+      @_hash['action_reason'] = 'actionReason'
+      @_hash['additional_amount'] = 'additionalAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message_type
+        payment_instrument_identifier
+        transaction_identifier
+        system_trace_number
+        retrieval_reference_number
+        transaction_amount
+        transaction_currency
+        approval_code
+        action_code
+        action_reason
+        additional_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        message_type
+        payment_instrument_identifier
+        transaction_identifier
+        system_trace_number
+        retrieval_reference_number
+        transaction_amount
+        transaction_currency
+        approval_code
+        action_code
+        action_reason
+        additional_amount
+      ]
+    end
+
+    def initialize(message_type: SKIP, payment_instrument_identifier: SKIP,
+                   transaction_identifier: SKIP, system_trace_number: SKIP,
+                   retrieval_reference_number: SKIP, transaction_amount: SKIP,
+                   transaction_currency: SKIP, approval_code: SKIP,
+                   action_code: SKIP, action_reason: SKIP,
+                   additional_amount: SKIP)
+      @message_type = message_type unless message_type == SKIP
+      unless payment_instrument_identifier == SKIP
+        @payment_instrument_identifier =
+          payment_instrument_identifier
+      end
+      @transaction_identifier = transaction_identifier unless transaction_identifier == SKIP
+      @system_trace_number = system_trace_number unless system_trace_number == SKIP
+      unless retrieval_reference_number == SKIP
+        @retrieval_reference_number =
+          retrieval_reference_number
+      end
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @transaction_currency = transaction_currency unless transaction_currency == SKIP
+      @approval_code = approval_code unless approval_code == SKIP
+      @action_code = action_code unless action_code == SKIP
+      @action_reason = action_reason unless action_reason == SKIP
+      @additional_amount = additional_amount unless additional_amount == 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.
+      message_type = hash.key?('messageType') ? hash['messageType'] : SKIP
+      payment_instrument_identifier =
+        hash.key?('paymentInstrumentIdentifier') ? hash['paymentInstrumentIdentifier'] : SKIP
+      transaction_identifier =
+        hash.key?('transactionIdentifier') ? hash['transactionIdentifier'] : SKIP
+      system_trace_number =
+        hash.key?('systemTraceNumber') ? hash['systemTraceNumber'] : SKIP
+      retrieval_reference_number =
+        hash.key?('retrievalReferenceNumber') ? hash['retrievalReferenceNumber'] : SKIP
+      transaction_amount =
+        hash.key?('transactionAmount') ? hash['transactionAmount'] : SKIP
+      transaction_currency =
+        hash.key?('transactionCurrency') ? hash['transactionCurrency'] : SKIP
+      approval_code = hash.key?('approvalCode') ? hash['approvalCode'] : SKIP
+      action_code = hash.key?('actionCode') ? hash['actionCode'] : SKIP
+      action_reason = hash.key?('actionReason') ? hash['actionReason'] : SKIP
+      additional_amount =
+        hash.key?('additionalAmount') ? hash['additionalAmount'] : SKIP
+
+      # Create object from extracted values.
+      PaymentStatusDetail.new(message_type: message_type,
+                              payment_instrument_identifier: payment_instrument_identifier,
+                              transaction_identifier: transaction_identifier,
+                              system_trace_number: system_trace_number,
+                              retrieval_reference_number: retrieval_reference_number,
+                              transaction_amount: transaction_amount,
+                              transaction_currency: transaction_currency,
+                              approval_code: approval_code,
+                              action_code: action_code,
+                              action_reason: action_reason,
+                              additional_amount: additional_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message_type: #{@message_type}, payment_instrument_identifier:"\
+      " #{@payment_instrument_identifier}, transaction_identifier: #{@transaction_identifier},"\
+      " system_trace_number: #{@system_trace_number}, retrieval_reference_number:"\
+      " #{@retrieval_reference_number}, transaction_amount: #{@transaction_amount},"\
+      " transaction_currency: #{@transaction_currency}, approval_code: #{@approval_code},"\
+      " action_code: #{@action_code}, action_reason: #{@action_reason}, additional_amount:"\
+      " #{@additional_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message_type: #{@message_type.inspect}, payment_instrument_identifier:"\
+      " #{@payment_instrument_identifier.inspect}, transaction_identifier:"\
+      " #{@transaction_identifier.inspect}, system_trace_number: #{@system_trace_number.inspect},"\
+      " retrieval_reference_number: #{@retrieval_reference_number.inspect}, transaction_amount:"\
+      " #{@transaction_amount.inspect}, transaction_currency: #{@transaction_currency.inspect},"\
+      " approval_code: #{@approval_code.inspect}, action_code: #{@action_code.inspect},"\
+      " action_reason: #{@action_reason.inspect}, additional_amount:"\
+      " #{@additional_amount.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/phone.rb

@@ -0,0 +1,75 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a phone contact, including the phone number and its type. Used
+  # for storing and transferring phone contact information in requests and
+  # responses.
+  class Phone < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The phone number, typically in E.164 or local format.
+    # @return [String]
+    attr_accessor :number
+
+    # The type of phone number (e.g., Mobile, Work, Home).
+    # @return [Type]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        number
+      ]
+    end
+
+    def initialize(number: SKIP, type: SKIP)
+      @number = number unless number == SKIP
+      @type = type unless type == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      Phone.new(number: number,
+                type: type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/gd_bos_v1/models/phone_number.rb

@@ -0,0 +1,111 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # Represents a phone number and related metadata for a user. Contains the
+  # phone number value, type, verification status, default flag, and last
+  # updated timestamp. Used to store and manage user contact information for
+  # notifications, authentication, and communication purposes.
+  class PhoneNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user's phone number.
+    # @return [String]
+    attr_accessor :number
+
+    # The type of phone number (e.g., "Mobile", "Home", "Work").
+    # @return [String]
+    attr_accessor :type
+
+    # Indicates whether this phone number is the user's default contact number.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # Indicates whether the phone number has been verified.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_verified
+
+    # The date and time when the phone number was last updated, typically in ISO
+    # 8601 format.
+    # @return [String]
+    attr_accessor :last_updated_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['type'] = 'type'
+      @_hash['is_default'] = 'isDefault'
+      @_hash['is_verified'] = 'isVerified'
+      @_hash['last_updated_date_time'] = 'lastUpdatedDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        type
+        is_default
+        is_verified
+        last_updated_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        number
+        type
+        last_updated_date_time
+      ]
+    end
+
+    def initialize(number: SKIP, type: SKIP, is_default: SKIP,
+                   is_verified: SKIP, last_updated_date_time: SKIP)
+      @number = number unless number == SKIP
+      @type = type unless type == SKIP
+      @is_default = is_default unless is_default == SKIP
+      @is_verified = is_verified unless is_verified == SKIP
+      @last_updated_date_time = last_updated_date_time unless last_updated_date_time == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      is_default = hash.key?('isDefault') ? hash['isDefault'] : SKIP
+      is_verified = hash.key?('isVerified') ? hash['isVerified'] : SKIP
+      last_updated_date_time =
+        hash.key?('lastUpdatedDateTime') ? hash['lastUpdatedDateTime'] : SKIP
+
+      # Create object from extracted values.
+      PhoneNumber.new(number: number,
+                      type: type,
+                      is_default: is_default,
+                      is_verified: is_verified,
+                      last_updated_date_time: last_updated_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, type: #{@type}, is_default: #{@is_default},"\
+      " is_verified: #{@is_verified}, last_updated_date_time: #{@last_updated_date_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, type: #{@type.inspect}, is_default:"\
+      " #{@is_default.inspect}, is_verified: #{@is_verified.inspect}, last_updated_date_time:"\
+      " #{@last_updated_date_time.inspect}>"
+    end
+  end
+end