fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/unit_type1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # SHARES, CURRENCY
+  class UnitType1
+    UNIT_TYPE1 = [
+      # TODO: Write general description for CURRENCY
+      CURRENCY = 'CURRENCY'.freeze,
+
+      # TODO: Write general description for SHARES
+      SHARES = 'SHARES'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/unit_type3.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of unit. One of SHARES, CURRENCY
+  class UnitType3
+    UNIT_TYPE3 = [
+      # TODO: Write general description for CURRENCY
+      CURRENCY = 'CURRENCY'.freeze,
+
+      # TODO: Write general description for SHARES
+      SHARES = 'SHARES'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/updates_metadata_entity.rb

@@ -0,0 +1,77 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Change IDs for synchronizable result sets
+  class UpdatesMetadataEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_update_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_update_id'] = 'nextUpdateId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_update_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_update_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_update_id = next_update_id unless next_update_id == 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.
+      next_update_id = hash.key?('nextUpdateId') ? hash['nextUpdateId'] : 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.
+      UpdatesMetadataEntity.new(next_update_id: next_update_id,
+                                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} next_update_id: #{@next_update_id}, 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} next_update_id: #{@next_update_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/updates_metadata_entity2.rb

@@ -0,0 +1,77 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Update IDs for retrieving updates since query
+  class UpdatesMetadataEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Opaque identifier. Does not need to be numeric or have any specific
+    # pattern. Implementation specific
+    # @return [String]
+    attr_accessor :next_update_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_update_id'] = 'nextUpdateId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_update_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_update_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_update_id = next_update_id unless next_update_id == 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.
+      next_update_id = hash.key?('nextUpdateId') ? hash['nextUpdateId'] : 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.
+      UpdatesMetadataEntity2.new(next_update_id: next_update_id,
+                                 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} next_update_id: #{@next_update_id}, 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} next_update_id: #{@next_update_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/vesting_entity.rb

@@ -0,0 +1,186 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Represents the vesting of ownership of an investment account
+  class VestingEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Vesting date
+    # @return [Date]
+    attr_accessor :vesting_date
+
+    # Security symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Strike price
+    # @return [Float]
+    attr_accessor :strike_price
+
+    # Vesting percentage
+    # @return [Float]
+    attr_accessor :vesting_percentage
+
+    # Other vested amount
+    # @return [Float]
+    attr_accessor :other_vest_amount
+
+    # Other vested percentage
+    # @return [Float]
+    attr_accessor :other_vest_percentage
+
+    # Vested balance
+    # @return [Float]
+    attr_accessor :vested_balance
+
+    # Unvested balance
+    # @return [Float]
+    attr_accessor :un_vested_balance
+
+    # Vested quantity
+    # @return [Float]
+    attr_accessor :vested_quantity
+
+    # Unvested quantity
+    # @return [Float]
+    attr_accessor :un_vested_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vesting_date'] = 'vestingDate'
+      @_hash['symbol'] = 'symbol'
+      @_hash['strike_price'] = 'strikePrice'
+      @_hash['vesting_percentage'] = 'vestingPercentage'
+      @_hash['other_vest_amount'] = 'otherVestAmount'
+      @_hash['other_vest_percentage'] = 'otherVestPercentage'
+      @_hash['vested_balance'] = 'vestedBalance'
+      @_hash['un_vested_balance'] = 'unVestedBalance'
+      @_hash['vested_quantity'] = 'vestedQuantity'
+      @_hash['un_vested_quantity'] = 'unVestedQuantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vesting_date
+        symbol
+        strike_price
+        vesting_percentage
+        other_vest_amount
+        other_vest_percentage
+        vested_balance
+        un_vested_balance
+        vested_quantity
+        un_vested_quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vesting_date: SKIP, symbol: SKIP, strike_price: SKIP,
+                   vesting_percentage: SKIP, other_vest_amount: SKIP,
+                   other_vest_percentage: SKIP, vested_balance: SKIP,
+                   un_vested_balance: SKIP, vested_quantity: SKIP,
+                   un_vested_quantity: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @vesting_date = vesting_date unless vesting_date == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @strike_price = strike_price unless strike_price == SKIP
+      @vesting_percentage = vesting_percentage unless vesting_percentage == SKIP
+      @other_vest_amount = other_vest_amount unless other_vest_amount == SKIP
+      @other_vest_percentage = other_vest_percentage unless other_vest_percentage == SKIP
+      @vested_balance = vested_balance unless vested_balance == SKIP
+      @un_vested_balance = un_vested_balance unless un_vested_balance == SKIP
+      @vested_quantity = vested_quantity unless vested_quantity == SKIP
+      @un_vested_quantity = un_vested_quantity unless un_vested_quantity == 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.
+      vesting_date = hash.key?('vestingDate') ? hash['vestingDate'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      strike_price = hash.key?('strikePrice') ? hash['strikePrice'] : SKIP
+      vesting_percentage =
+        hash.key?('vestingPercentage') ? hash['vestingPercentage'] : SKIP
+      other_vest_amount =
+        hash.key?('otherVestAmount') ? hash['otherVestAmount'] : SKIP
+      other_vest_percentage =
+        hash.key?('otherVestPercentage') ? hash['otherVestPercentage'] : SKIP
+      vested_balance = hash.key?('vestedBalance') ? hash['vestedBalance'] : SKIP
+      un_vested_balance =
+        hash.key?('unVestedBalance') ? hash['unVestedBalance'] : SKIP
+      vested_quantity =
+        hash.key?('vestedQuantity') ? hash['vestedQuantity'] : SKIP
+      un_vested_quantity =
+        hash.key?('unVestedQuantity') ? hash['unVestedQuantity'] : 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.
+      VestingEntity.new(vesting_date: vesting_date,
+                        symbol: symbol,
+                        strike_price: strike_price,
+                        vesting_percentage: vesting_percentage,
+                        other_vest_amount: other_vest_amount,
+                        other_vest_percentage: other_vest_percentage,
+                        vested_balance: vested_balance,
+                        un_vested_balance: un_vested_balance,
+                        vested_quantity: vested_quantity,
+                        un_vested_quantity: un_vested_quantity,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VestingEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vesting_date: #{@vesting_date}, symbol: #{@symbol}, strike_price:"\
+      " #{@strike_price}, vesting_percentage: #{@vesting_percentage}, other_vest_amount:"\
+      " #{@other_vest_amount}, other_vest_percentage: #{@other_vest_percentage}, vested_balance:"\
+      " #{@vested_balance}, un_vested_balance: #{@un_vested_balance}, vested_quantity:"\
+      " #{@vested_quantity}, un_vested_quantity: #{@un_vested_quantity}, 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} vesting_date: #{@vesting_date.inspect}, symbol: #{@symbol.inspect},"\
+      " strike_price: #{@strike_price.inspect}, vesting_percentage:"\
+      " #{@vesting_percentage.inspect}, other_vest_amount: #{@other_vest_amount.inspect},"\
+      " other_vest_percentage: #{@other_vest_percentage.inspect}, vested_balance:"\
+      " #{@vested_balance.inspect}, un_vested_balance: #{@un_vested_balance.inspect},"\
+      " vested_quantity: #{@vested_quantity.inspect}, un_vested_quantity:"\
+      " #{@un_vested_quantity.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/fdx_api/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/utilities/union_type_lookup.rb

@@ -0,0 +1,240 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :AccountWithDetails => AnyOf.new(
+          [
+            LeafType.new(AnnuityAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'ANNUITY_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(CommercialAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'COMMERCIAL_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(DepositAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'DEPOSIT_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(DigitalWalletAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'DIGITAL_WALLET',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(InsuranceAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'INSURANCE_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(InvestmentAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'INVESTMENT_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(LineOfCreditAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'LOC_ACCOUNT',
+              discriminator: 'accountCategory'
+            )),
+            LeafType.new(LoanAccountEntity, UnionTypeContext.new(
+              discriminator_value: 'LOAN_ACCOUNT',
+              discriminator: 'accountCategory'
+            ))
+          ]
+        ),
+
+        :AccountsEntityAccounts => AnyOf.new(
+          [
+            LeafType.new(AnnuityAccountEntity),
+            LeafType.new(CommercialAccountEntity),
+            LeafType.new(DepositAccountEntity),
+            LeafType.new(DigitalWalletAccountEntity),
+            LeafType.new(InsuranceAccountEntity),
+            LeafType.new(InvestmentAccountEntity),
+            LeafType.new(LineOfCreditAccountEntity),
+            LeafType.new(LoanAccountEntity)
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        ),
+
+        :HoldingEntitySecurity => AnyOf.new(
+          [
+            LeafType.new(DebtSecurityEntity),
+            LeafType.new(MutualFundSecurityEntity),
+            LeafType.new(OptionSecurityEntity),
+            LeafType.new(OtherSecurityEntity),
+            LeafType.new(StockSecurityEntity),
+            LeafType.new(SweepSecurityEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :TransactionsEntityTransactions => AnyOf.new(
+          [
+            LeafType.new(CommercialTransactionEntity),
+            LeafType.new(DepositTransactionEntity),
+            LeafType.new(DigitalWalletTransactionEntity),
+            LeafType.new(InsuranceTransactionEntity),
+            LeafType.new(InvestmentTransactionEntity),
+            LeafType.new(LineOfCreditTransactionEntity),
+            LeafType.new(LoanTransactionEntity)
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        ),
+
+        :FinancialInstitutionEntityFiId => AnyOf.new(
+          [
+            LeafType.new(Iso93622014BusinessIdentifierCodeEntity),
+            LeafType.new(Iso93622022BusinessIdentifierCodeEntity),
+            LeafType.new(GenericFinancialInstitutionIdEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :GenericAccountIdentificationEntityIdScheme => AnyOf.new(
+          [
+            LeafType.new(ExternalAccountIdSchemeEntity),
+            LeafType.new(ProprietaryAccountIdSchemeEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :GenericFinancialInstitutionIdEntityIdScheme => AnyOf.new(
+          [
+            LeafType.new(ExternalFinancialInstitutionIdSchemeEntity),
+            LeafType.new(ProprietaryFinancialInstitutionIdSchemeEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentDeliveryAddressEntityAddress => AnyOf.new(
+          [
+            LeafType.new(ElectronicAddressEntity),
+            LeafType.new(TelephoneNumber),
+            LeafType.new(Address)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentGenericAccountEntityId => AnyOf.new(
+          [
+            LeafType.new(Iban2007IdentifierEntity),
+            LeafType.new(GenericAccountIdentificationEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentInitiationPartyContactMethodEntityAddress => AnyOf.new(
+          [
+            LeafType.new(ElectronicAddressEntity),
+            LeafType.new(TelephoneNumber),
+            LeafType.new(Address)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentInitiationPartyNameEntityDetail => AnyOf.new(
+          [
+            LeafType.new(OrganizationNameEntity),
+            LeafType.new(IndividualName)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentInitiationPartyToPaymentMethodEntityAccount => AnyOf.new(
+          [
+            LeafType.new(PaymentMethodCreditAccountEntity),
+            LeafType.new(PaymentMethodDebitAccountEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :FinancialInstitutionEntity2FiId => AnyOf.new(
+          [
+            LeafType.new(Iso93622014BusinessIdentifierCodeEntity),
+            LeafType.new(Iso93622022BusinessIdentifierCodeEntity),
+            LeafType.new(GenericFinancialInstitutionIdEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentGenericAccountEntity1Id => AnyOf.new(
+          [
+            LeafType.new(Iban2007IdentifierEntity),
+            LeafType.new(GenericAccountIdentificationEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentGenericAccountEntity2Id => AnyOf.new(
+          [
+            LeafType.new(Iban2007IdentifierEntity),
+            LeafType.new(GenericAccountIdentificationEntity)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentInitiationPartyNameEntity1Detail => AnyOf.new(
+          [
+            LeafType.new(OrganizationNameEntity),
+            LeafType.new(IndividualName)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PaymentInitiationPartyNameEntity3Detail => AnyOf.new(
+          [
+            LeafType.new(OrganizationNameEntity),
+            LeafType.new(IndividualName)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end