fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/request_for_payment_status.rb

@@ -0,0 +1,74 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Defines the Request For Payment lifecycle.   * `ACCEPTED`: The RFP was
+  # authorized and payment transaction is complete or processing   * `BLOCKED`:
+  # The RFP was authorized but payment requested was blocked   * `CANCELLED`:
+  # The RFP was authorized but payment requested was cancelled   * `EXPIRED`:
+  # The Request for Payment has expired before action   * `PARTIALLY_ACCEPTED`:
+  # The RFP was authorized and payment requested is partially accepted /
+  # processing   * `PENDING`: The RFP was authorized and payment requested is
+  # now pending   * `PRESENTED`: Request for Payment has been presented to the
+  # Debtor and awaits authorization   * `RECEIVED`: The RFP was authorized and
+  # payment instruction has been received by Debtor   * `REJECTED`: The RFP was
+  # authorized but payment transaction has been rejected
+  class RequestForPaymentStatus
+    REQUEST_FOR_PAYMENT_STATUS = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for BLOCKED
+      BLOCKED = 'BLOCKED'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for PARTIALLY_ACCEPTED
+      PARTIALLY_ACCEPTED = 'PARTIALLY_ACCEPTED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for PRESENTED
+      PRESENTED = 'PRESENTED'.freeze,
+
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'RECEIVED'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'blocked' then BLOCKED
+      when 'cancelled' then CANCELLED
+      when 'expired' then EXPIRED
+      when 'partially_accepted' then PARTIALLY_ACCEPTED
+      when 'pending' then PENDING
+      when 'presented' then PRESENTED
+      when 'received' then RECEIVED
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/request_for_payment_status2.rb

@@ -0,0 +1,64 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The current status of the request for payment
+  class RequestForPaymentStatus2
+    REQUEST_FOR_PAYMENT_STATUS2 = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for BLOCKED
+      BLOCKED = 'BLOCKED'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for PARTIALLY_ACCEPTED
+      PARTIALLY_ACCEPTED = 'PARTIALLY_ACCEPTED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for PRESENTED
+      PRESENTED = 'PRESENTED'.freeze,
+
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'RECEIVED'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'blocked' then BLOCKED
+      when 'cancelled' then CANCELLED
+      when 'expired' then EXPIRED
+      when 'partially_accepted' then PARTIALLY_ACCEPTED
+      when 'pending' then PENDING
+      when 'presented' then PRESENTED
+      when 'received' then RECEIVED
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/request_for_payment_summary_entity.rb

@@ -0,0 +1,158 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Summary information for a prior request for payment
+  class RequestForPaymentSummaryEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Uniquely identifies a request for payment
+    # @return [String]
+    attr_accessor :rfp_id
+
+    # ID of the account used to source funds for payment
+    # @return [String]
+    attr_accessor :account_id
+
+    # Amount for the payment. Must be positive
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code if it is different from the account's currency
+    # @return [Iso4217CurrencyCode6]
+    attr_accessor :currency_code
+
+    # The payee merchant to receive funds from the payment, can be extended to
+    # support additional types of payees
+    # @return [PayeeEntity1]
+    attr_accessor :payee
+
+    # Date that the funds are being requested to be delivered
+    # @return [Date]
+    attr_accessor :due_date
+
+    # The current status of the request for payment
+    # @return [RequestForPaymentStatus2]
+    attr_accessor :status
+
+    # The purpose of the request for payment as provided by consumer or
+    # payment-requesting app
+    # @return [String]
+    attr_accessor :description
+
+    # Resource URL for retrieving full request for payment details
+    # @return [HateoasLink7]
+    attr_accessor :link
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rfp_id'] = 'rfpId'
+      @_hash['account_id'] = 'accountId'
+      @_hash['amount'] = 'amount'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['payee'] = 'payee'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['link'] = 'link'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        rfp_id
+        account_id
+        amount
+        currency_code
+        payee
+        due_date
+        status
+        description
+        link
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rfp_id: SKIP, account_id: SKIP, amount: SKIP,
+                   currency_code: SKIP, payee: SKIP, due_date: SKIP,
+                   status: SKIP, description: SKIP, link: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @rfp_id = rfp_id unless rfp_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @amount = amount unless amount == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @payee = payee unless payee == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @link = link unless link == SKIP
+      @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.
+      rfp_id = hash.key?('rfpId') ? hash['rfpId'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      payee = PayeeEntity1.from_hash(hash['payee']) if hash['payee']
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      link = HateoasLink7.from_hash(hash['link']) if hash['link']
+
+      # 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.
+      RequestForPaymentSummaryEntity.new(rfp_id: rfp_id,
+                                         account_id: account_id,
+                                         amount: amount,
+                                         currency_code: currency_code,
+                                         payee: payee,
+                                         due_date: due_date,
+                                         status: status,
+                                         description: description,
+                                         link: link,
+                                         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} rfp_id: #{@rfp_id}, account_id: #{@account_id}, amount: #{@amount},"\
+      " currency_code: #{@currency_code}, payee: #{@payee}, due_date: #{@due_date}, status:"\
+      " #{@status}, description: #{@description}, link: #{@link}, 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} rfp_id: #{@rfp_id.inspect}, account_id: #{@account_id.inspect}, amount:"\
+      " #{@amount.inspect}, currency_code: #{@currency_code.inspect}, payee: #{@payee.inspect},"\
+      " due_date: #{@due_date.inspect}, status: #{@status.inspect}, description:"\
+      " #{@description.inspect}, link: #{@link.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/request_for_payments_entity.rb

@@ -0,0 +1,113 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Search result list of submitted request for payments
+  class RequestForPaymentsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page keys 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
+
+    # Search result list of request for payments
+    # @return [Array[RequestForPaymentSummaryEntity]]
+    attr_accessor :rfps
+
+    # 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['rfps'] = 'rfps'
+      @_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(rfps:, 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
+      @rfps = rfps
+      @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
+      rfps = nil
+      unless hash['rfps'].nil?
+        rfps = []
+        hash['rfps'].each do |structure|
+          rfps << (RequestForPaymentSummaryEntity.from_hash(structure) if structure)
+        end
+      end
+
+      rfps = nil unless hash.key?('rfps')
+      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.
+      RequestForPaymentsEntity.new(rfps: rfps,
+                                   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}, rfps: #{@rfps},"\
+      " 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}, rfps: #{@rfps.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/result_type.rb

@@ -0,0 +1,39 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Flag to indicate if you want a lightweight array of metadata
+  # (AccountDescriptor or Tax or Operations) or full item details (Account or a
+  # Tax subclass or Availability details). If set to 'lightweight', should only
+  # return the fields associated with the metadata entity.
+  class ResultType
+    RESULT_TYPE = [
+      # TODO: Write general description for DETAILS
+      DETAILS = 'details'.freeze,
+
+      # TODO: Write general description for LIGHTWEIGHT
+      LIGHTWEIGHT = 'lightweight'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DETAILS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'details' then DETAILS
+      when 'lightweight' then LIGHTWEIGHT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/result_type1.rb

@@ -0,0 +1,37 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Indicates whether response array of `lightweight` payroll report summaries
+  # or of `detail` full payroll reports is being returned
+  class ResultType1
+    RESULT_TYPE1 = [
+      # TODO: Write general description for DETAILS
+      DETAILS = 'details'.freeze,
+
+      # TODO: Write general description for LIGHTWEIGHT
+      LIGHTWEIGHT = 'lightweight'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DETAILS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'details' then DETAILS
+      when 'lightweight' then LIGHTWEIGHT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/retirement_plan_type.rb

@@ -0,0 +1,57 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # K-1 Supplemental IRS-supported retirement plan types for Form 1065 Schedule
+  # K-1 box 13 or Form 1120-S Schedule K-1 box 12
+  class RetirementPlanType
+    RETIREMENT_PLAN_TYPE = [
+      # TODO: Write general description for DEFINED_BENEFIT_PLAN
+      DEFINED_BENEFIT_PLAN = 'DEFINED_BENEFIT_PLAN'.freeze,
+
+      # TODO: Write general description for MONEY_PURCHASE_PLAN
+      MONEY_PURCHASE_PLAN = 'MONEY_PURCHASE_PLAN'.freeze,
+
+      # TODO: Write general description for PROFIT_SHARING_PLAN
+      PROFIT_SHARING_PLAN = 'PROFIT_SHARING_PLAN'.freeze,
+
+      # TODO: Write general description for ROTH_IRA
+      ROTH_IRA = 'ROTH_IRA'.freeze,
+
+      # TODO: Write general description for SEP_IRA
+      SEP_IRA = 'SEP_IRA'.freeze,
+
+      # TODO: Write general description for SIMPLE
+      SIMPLE = 'SIMPLE'.freeze,
+
+      # TODO: Write general description for TRADITIONAL_IRA
+      TRADITIONAL_IRA = 'TRADITIONAL_IRA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEFINED_BENEFIT_PLAN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'defined_benefit_plan' then DEFINED_BENEFIT_PLAN
+      when 'money_purchase_plan' then MONEY_PURCHASE_PLAN
+      when 'profit_sharing_plan' then PROFIT_SHARING_PLAN
+      when 'roth_ira' then ROTH_IRA
+      when 'sep_ira' then SEP_IRA
+      when 'simple' then SIMPLE
+      when 'traditional_ira' then TRADITIONAL_IRA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/retirement_plan_type2.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Retirement plan type for 1065 K-1 box 13 or 1120-S K-1 box 12
+  class RetirementPlanType2
+    RETIREMENT_PLAN_TYPE2 = [
+      # TODO: Write general description for DEFINED_BENEFIT_PLAN
+      DEFINED_BENEFIT_PLAN = 'DEFINED_BENEFIT_PLAN'.freeze,
+
+      # TODO: Write general description for MONEY_PURCHASE_PLAN
+      MONEY_PURCHASE_PLAN = 'MONEY_PURCHASE_PLAN'.freeze,
+
+      # TODO: Write general description for PROFIT_SHARING_PLAN
+      PROFIT_SHARING_PLAN = 'PROFIT_SHARING_PLAN'.freeze,
+
+      # TODO: Write general description for ROTH_IRA
+      ROTH_IRA = 'ROTH_IRA'.freeze,
+
+      # TODO: Write general description for SEP_IRA
+      SEP_IRA = 'SEP_IRA'.freeze,
+
+      # TODO: Write general description for SIMPLE
+      SIMPLE = 'SIMPLE'.freeze,
+
+      # TODO: Write general description for TRADITIONAL_IRA
+      TRADITIONAL_IRA = 'TRADITIONAL_IRA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEFINED_BENEFIT_PLAN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'defined_benefit_plan' then DEFINED_BENEFIT_PLAN
+      when 'money_purchase_plan' then MONEY_PURCHASE_PLAN
+      when 'profit_sharing_plan' then PROFIT_SHARING_PLAN
+      when 'roth_ira' then ROTH_IRA
+      when 'sep_ira' then SEP_IRA
+      when 'simple' then SIMPLE
+      when 'traditional_ira' then TRADITIONAL_IRA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/revocation_request_entity.rb

@@ -0,0 +1,96 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details of request to revoke consent
+  class RevocationRequestEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the revocation or status change, one of `BUSINESS_RULE`,
+    # `SECURITY_EVENT`, `USER_ACTION` or `OTHER`
+    # @return [UpdateReason2]
+    attr_accessor :reason
+
+    # Text description of an `OTHER` reason
+    # @return [String]
+    attr_accessor :other_reason
+
+    # The party initiating revocation
+    # @return [PartyType2]
+    attr_accessor :initiator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['other_reason'] = 'otherReason'
+      @_hash['initiator'] = 'initiator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        other_reason
+        initiator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP, other_reason: SKIP, initiator: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reason = reason unless reason == SKIP
+      @other_reason = other_reason unless other_reason == SKIP
+      @initiator = initiator unless initiator == SKIP
+      @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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      other_reason = hash.key?('otherReason') ? hash['otherReason'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : SKIP
+
+      # 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.
+      RevocationRequestEntity.new(reason: reason,
+                                  other_reason: other_reason,
+                                  initiator: initiator,
+                                  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} reason: #{@reason}, other_reason: #{@other_reason}, initiator:"\
+      " #{@initiator}, 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} reason: #{@reason.inspect}, other_reason: #{@other_reason.inspect},"\
+      " initiator: #{@initiator.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end