fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_network_type.rb

@@ -0,0 +1,43 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Suggested values for Payment Network Type.   | Value | Description |
+  # |-----|-----|   | CA_ACSS | Automated Clearing House Settlement System |   |
+  # CA_LVTS | Large-Value Transfer System |   | US_ACH | Automated Clearing
+  # House |   | US_CHIPS | Clearinghouse Interbank Payments System |   |
+  # US_FEDNOW | Federal Reserve Instant Payment System |   | US_FEDWIRE |
+  # Fedwire Funds Service |   | US_RTP | US Real Time Payments System |
+  class PaymentNetworkType
+    PAYMENT_NETWORK_TYPE = [
+      # TODO: Write general description for CA_ACSS
+      CA_ACSS = 'CA_ACSS'.freeze,
+
+      # TODO: Write general description for CA_LVTS
+      CA_LVTS = 'CA_LVTS'.freeze,
+
+      # TODO: Write general description for US_ACH
+      US_ACH = 'US_ACH'.freeze,
+
+      # TODO: Write general description for US_CHIPS
+      US_CHIPS = 'US_CHIPS'.freeze,
+
+      # TODO: Write general description for US_FEDNOW
+      US_FEDNOW = 'US_FEDNOW'.freeze,
+
+      # TODO: Write general description for US_FEDWIRE
+      US_FEDWIRE = 'US_FEDWIRE'.freeze,
+
+      # TODO: Write general description for US_RTP
+      US_RTP = 'US_RTP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_network_type2.rb

@@ -0,0 +1,39 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of Canadian or U.S. payment network, CA_ACSS, CA_LVTS, US_ACH,
+  # US_CHIPS, US_FEDWIRE, US_RTP
+  class PaymentNetworkType2
+    PAYMENT_NETWORK_TYPE2 = [
+      # TODO: Write general description for CA_ACSS
+      CA_ACSS = 'CA_ACSS'.freeze,
+
+      # TODO: Write general description for CA_LVTS
+      CA_LVTS = 'CA_LVTS'.freeze,
+
+      # TODO: Write general description for US_ACH
+      US_ACH = 'US_ACH'.freeze,
+
+      # TODO: Write general description for US_CHIPS
+      US_CHIPS = 'US_CHIPS'.freeze,
+
+      # TODO: Write general description for US_FEDNOW
+      US_FEDNOW = 'US_FEDNOW'.freeze,
+
+      # TODO: Write general description for US_FEDWIRE
+      US_FEDWIRE = 'US_FEDWIRE'.freeze,
+
+      # TODO: Write general description for US_RTP
+      US_RTP = 'US_RTP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_status.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the payment lifecycle.   * `CANCELLED`: Payment was cancelled by the
+  # user   * `FAILED`: Payment failed for reasons other than "No Funds" For
+  # example: fraud, invalid payee, source account was closed etc.   * `NOFUNDS`:
+  # Payment failed because of the lack of funds   * `PROCESSED`: The payment has
+  # been executed by the payment service provider   * `PROCESSING`: Payment is
+  # in the process of being executed by the payment service provider   *
+  # `SCHEDULED`: Payment has been scheduled
+  class PaymentStatus
+    PAYMENT_STATUS = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for NOFUNDS
+      NOFUNDS = 'NOFUNDS'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'PROCESSED'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_status1.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # CANCELLED, FAILED, NOFUNDS, PROCESSED, PROCESSING, SCHEDULED
+  class PaymentStatus1
+    PAYMENT_STATUS1 = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for NOFUNDS
+      NOFUNDS = 'NOFUNDS'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'PROCESSED'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_status3.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the status of the payment
+  class PaymentStatus3
+    PAYMENT_STATUS3 = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for NOFUNDS
+      NOFUNDS = 'NOFUNDS'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'PROCESSED'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payments_entity.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A list of payments
+  class PaymentsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Update IDs for retrieving updates since query
+    # @return [UpdatesMetadataEntity2]
+    attr_accessor :updates
+
+    # Resource URLs for navigating result sets
+    # @return [SynchronizableArrayLinksEntity2]
+    attr_accessor :links
+
+    # Payments retrieved by the operation
+    # @return [Array[PaymentEntity]]
+    attr_accessor :payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['updates'] = 'updates'
+      @_hash['links'] = 'links'
+      @_hash['payments'] = 'payments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        updates
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payments:, page: SKIP, updates: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @updates = updates unless updates == SKIP
+      @links = links unless links == SKIP
+      @payments = payments
+      @additional_properties = additional_properties
+    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
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (PaymentEntity.from_hash(structure) if structure)
+        end
+      end
+
+      payments = nil unless hash.key?('payments')
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      updates = UpdatesMetadataEntity2.from_hash(hash['updates']) if hash['updates']
+      links = SynchronizableArrayLinksEntity2.from_hash(hash['links']) if hash['links']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentsEntity.new(payments: payments,
+                         page: page,
+                         updates: updates,
+                         links: links,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, updates: #{@updates}, links: #{@links}, payments:"\
+      " #{@payments}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, updates: #{@updates.inspect}, links:"\
+      " #{@links.inspect}, payments: #{@payments.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payout_mode.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Frequency of annuity payments.   | Value | Description |   |-----|-----|   |
+  # ANNUALLY | Paid Annually |   | BIWEEKLY | Paid Bi-weekly |   | DAILY | Paid
+  # Daily |   | MONTHLY | Paid Monthly |   | SEMIANNUALLY | Paid Semi-annually |
+  #   | SEMIMONTHLY | Paid Semi-monthly |
+  class PayoutMode
+    PAYOUT_MODE = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payout_mode2.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Frequency of annuity payments
+  class PayoutMode2
+    PAYOUT_MODE2 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payout_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Indicates a type of payout such as immediate or deferred.   | Value |
+  # Description |   |-----|-----|   | DEFERRED | Deferred payout starts at a
+  # predetermined date in the future |   | IMMEDIATE | Immediate payout begins
+  # paying out shortly after the annuity is purchased |
+  class PayoutType
+    PAYOUT_TYPE = [
+      # TODO: Write general description for DEFERRED
+      DEFERRED = 'DEFERRED'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payout_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Indicates type of payout such as immediate or deferred
+  class PayoutType2
+    PAYOUT_TYPE2 = [
+      # TODO: Write general description for DEFERRED
+      DEFERRED = 'DEFERRED'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payroll_frequency_type.rb

@@ -0,0 +1,50 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The frequency of employee payments
+  class PayrollFrequencyType
+    PAYROLL_FREQUENCY_TYPE = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BI_WEEKLY
+      BI_WEEKLY = 'BI_WEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for EVERY_2_6_WEEKS
+      EVERY_2_6_WEEKS = 'EVERY_2_6_WEEKS'.freeze,
+
+      # TODO: Write general description for EVERY_4_WEEKS
+      EVERY_4_WEEKS = 'EVERY_4_WEEKS'.freeze,
+
+      # TODO: Write general description for EVERY_5_2_WEEKS
+      EVERY_5_2_WEEKS = 'EVERY_5_2_WEEKS'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMI_ANNUALLY
+      SEMI_ANNUALLY = 'SEMI_ANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMI_MONTHLY
+      SEMI_MONTHLY = 'SEMI_MONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payroll_frequency_type2.rb

@@ -0,0 +1,50 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The frequency of payments
+  class PayrollFrequencyType2
+    PAYROLL_FREQUENCY_TYPE2 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BI_WEEKLY
+      BI_WEEKLY = 'BI_WEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for EVERY_2_6_WEEKS
+      EVERY_2_6_WEEKS = 'EVERY_2_6_WEEKS'.freeze,
+
+      # TODO: Write general description for EVERY_4_WEEKS
+      EVERY_4_WEEKS = 'EVERY_4_WEEKS'.freeze,
+
+      # TODO: Write general description for EVERY_5_2_WEEKS
+      EVERY_5_2_WEEKS = 'EVERY_5_2_WEEKS'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMI_ANNUALLY
+      SEMI_ANNUALLY = 'SEMI_ANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMI_MONTHLY
+      SEMI_MONTHLY = 'SEMI_MONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payroll_rate_type.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Specifies whether the employee's pay is ANNUAL, DAILY, HOURLY, OTHER
+  class PayrollRateType
+    PAYROLL_RATE_TYPE = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for HOURLY
+      HOURLY = 'HOURLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payroll_rate_type2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Whether the worker's rate is ANNUAL, DAILY, HOURLY, OTHER
+  class PayrollRateType2
+    PAYROLL_RATE_TYPE2 = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for HOURLY
+      HOURLY = 'HOURLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end