apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/investment_holding_response.rb

@@ -0,0 +1,513 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InvestmentHoldingResponse Model.
+  class InvestmentHoldingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The original value of an asset for tax purposes, usually the purchase
+    # price, used to calculate capital gains or losses. Accumulated price.
+    # @return [Float]
+    attr_accessor :cost_basis
+
+    # The rate of return the bonds coupon rate generates.
+    # @return [String]
+    attr_accessor :coupon_yield
+
+    # The three-character ISO 4217 currency code, for example, `USD`.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The present market price of a single unit of the holding (for example,
+    # stock price per share).
+    # @return [Float]
+    attr_accessor :current_price
+
+    # The daily change in the `current_price` of the holding since the previous
+    # trading day.
+    # @return [Float]
+    attr_accessor :daily_change
+
+    # A brief description of the holding, such as the company name for stocks or
+    # the bond type for bonds.
+    # @return [String]
+    attr_accessor :description
+
+    # The expiration date associated with the holding.
+    # @return [String]
+    attr_accessor :expiration
+
+    # The nominal value of a bond or fixed-income security, paid to the holder
+    # at maturity.
+    # @return [Float]
+    attr_accessor :face_value
+
+    # The frequency of the interest paid on the bond (i.e. Annually, Monthly,
+    # etc.)
+    # @return [String]
+    attr_accessor :frequency
+
+    # The unique identifier for the holding. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The current market value of the holding, calculated as the current price
+    # times the number of units (shares) owned.
+    # @return [Float]
+    attr_accessor :market_value
+
+    # The maturity date associated with the holding.
+    # @return [String]
+    attr_accessor :maturity_date
+
+    # The percent change in the `current_price` of the holding compared to a
+    # previous time period. It is the percentage change that reflects the
+    # `daily_change`.
+    # @return [Float]
+    attr_accessor :percentage_change
+
+    # The average price paid for the holding.
+    # @return [Float]
+    attr_accessor :purchase_price
+
+    # The number of units of the holding owned (for example, number of shares of
+    # stock).
+    # @return [String]
+    attr_accessor :quantity
+
+    # The interest on the bond, subject to determining the payout amount of the
+    # bond.
+    # @return [Float]
+    attr_accessor :rate
+
+    # The strike price associated to the option.
+    # @return [Float]
+    attr_accessor :strike_price
+
+    # The ticker symbol or unique identifier of the holding, used in stock
+    # exchanges.
+    # @return [String]
+    attr_accessor :symbol
+
+    # The length of time until the bond's principal amount is due to be repaid.
+    # It is the period from when the bond is issued until it reaches its
+    # maturity date.
+    # @return [String]
+    attr_accessor :term
+
+    # The unrealized gain/loss amount for today.
+    # @return [Float]
+    attr_accessor :today_ugl_amount
+
+    # The unrealized gain/loss percentage for today.
+    # @return [Float]
+    attr_accessor :today_ugl_percentage
+
+    # The total unrealized gain/loss amount for an investment.
+    # @return [Float]
+    attr_accessor :total_ugl_amount
+
+    # The total unrealized gain/loss for the holding since it was acquired.
+    # @return [Float]
+    attr_accessor :total_ugl_percentage
+
+    # The number of units (for example, shares) of the holding that are not yet
+    # vested or owned outright by the holder.
+    # @return [Float]
+    attr_accessor :unvested_quantity
+
+    # The value of the portion of the holding that is unvested.
+    # @return [Float]
+    attr_accessor :unvested_value
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The number of units (for example, shares) of the holding that are vested
+    # and fully owned by the holder.
+    # @return [Float]
+    attr_accessor :vested_quantity
+
+    # The value of the portion of the holding that is vested and fully owned by
+    # the holder.
+    # @return [Float]
+    attr_accessor :vested_value
+
+    # The date and time the investment holding was created, represented in ISO
+    # 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The date and time when the current price was last updated, represented in
+    # ISO 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :current_price_as_of
+
+    # The date on which a security was issued or made available for sale.
+    # @return [String]
+    attr_accessor :issue_date
+
+    # The date from which the vesting schedule for a holding begins.
+    # @return [String]
+    attr_accessor :vesting_start_date
+
+    # The date from which the vesting schedule for a holding ends.
+    # @return [String]
+    attr_accessor :vesting_end_date
+
+    # States whether the option is a `PUT` or `CALL`.
+    # @return [String]
+    attr_accessor :put_or_call
+
+    # The type of investment (e.g., equity, fixed income, mutual fund, etc.)
+    # @return [String]
+    attr_accessor :holding_type
+
+    # The unit type of the term associated to the bond. (Year, Month, etc.)
+    # @return [String]
+    attr_accessor :term_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['cost_basis'] = 'cost_basis'
+      @_hash['coupon_yield'] = 'coupon_yield'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['current_price'] = 'current_price'
+      @_hash['daily_change'] = 'daily_change'
+      @_hash['description'] = 'description'
+      @_hash['expiration'] = 'expiration'
+      @_hash['face_value'] = 'face_value'
+      @_hash['frequency'] = 'frequency'
+      @_hash['guid'] = 'guid'
+      @_hash['market_value'] = 'market_value'
+      @_hash['maturity_date'] = 'maturity_date'
+      @_hash['percentage_change'] = 'percentage_change'
+      @_hash['purchase_price'] = 'purchase_price'
+      @_hash['quantity'] = 'quantity'
+      @_hash['rate'] = 'rate'
+      @_hash['strike_price'] = 'strike_price'
+      @_hash['symbol'] = 'symbol'
+      @_hash['term'] = 'term'
+      @_hash['today_ugl_amount'] = 'today_ugl_amount'
+      @_hash['today_ugl_percentage'] = 'today_ugl_percentage'
+      @_hash['total_ugl_amount'] = 'total_ugl_amount'
+      @_hash['total_ugl_percentage'] = 'total_ugl_percentage'
+      @_hash['unvested_quantity'] = 'unvested_quantity'
+      @_hash['unvested_value'] = 'unvested_value'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['vested_quantity'] = 'vested_quantity'
+      @_hash['vested_value'] = 'vested_value'
+      @_hash['created_at'] = 'created_at'
+      @_hash['current_price_as_of'] = 'current_price_as_of'
+      @_hash['issue_date'] = 'issue_date'
+      @_hash['vesting_start_date'] = 'vesting_start_date'
+      @_hash['vesting_end_date'] = 'vesting_end_date'
+      @_hash['put_or_call'] = 'put_or_call'
+      @_hash['holding_type'] = 'holding_type'
+      @_hash['term_unit'] = 'term_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        cost_basis
+        coupon_yield
+        currency_code
+        current_price
+        daily_change
+        description
+        expiration
+        face_value
+        frequency
+        guid
+        market_value
+        maturity_date
+        percentage_change
+        purchase_price
+        quantity
+        rate
+        strike_price
+        symbol
+        term
+        today_ugl_amount
+        today_ugl_percentage
+        total_ugl_amount
+        total_ugl_percentage
+        unvested_quantity
+        unvested_value
+        user_guid
+        vested_quantity
+        vested_value
+        created_at
+        current_price_as_of
+        issue_date
+        vesting_start_date
+        vesting_end_date
+        put_or_call
+        holding_type
+        term_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cost_basis
+        coupon_yield
+        currency_code
+        current_price
+        daily_change
+        description
+        expiration
+        face_value
+        frequency
+        guid
+        market_value
+        maturity_date
+        percentage_change
+        purchase_price
+        quantity
+        rate
+        strike_price
+        symbol
+        term
+        today_ugl_amount
+        today_ugl_percentage
+        total_ugl_amount
+        total_ugl_percentage
+        unvested_quantity
+        unvested_value
+        user_guid
+        vested_quantity
+        vested_value
+        created_at
+        current_price_as_of
+        issue_date
+        vesting_start_date
+        vesting_end_date
+        put_or_call
+        holding_type
+        term_unit
+      ]
+    end
+
+    def initialize(account_guid: SKIP, cost_basis: SKIP, coupon_yield: SKIP,
+                   currency_code: SKIP, current_price: SKIP, daily_change: SKIP,
+                   description: SKIP, expiration: SKIP, face_value: SKIP,
+                   frequency: SKIP, guid: SKIP, market_value: SKIP,
+                   maturity_date: SKIP, percentage_change: SKIP,
+                   purchase_price: SKIP, quantity: SKIP, rate: SKIP,
+                   strike_price: SKIP, symbol: SKIP, term: SKIP,
+                   today_ugl_amount: SKIP, today_ugl_percentage: SKIP,
+                   total_ugl_amount: SKIP, total_ugl_percentage: SKIP,
+                   unvested_quantity: SKIP, unvested_value: SKIP,
+                   user_guid: SKIP, vested_quantity: SKIP, vested_value: SKIP,
+                   created_at: SKIP, current_price_as_of: SKIP,
+                   issue_date: SKIP, vesting_start_date: SKIP,
+                   vesting_end_date: SKIP, put_or_call: SKIP,
+                   holding_type: SKIP, term_unit: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @cost_basis = cost_basis unless cost_basis == SKIP
+      @coupon_yield = coupon_yield unless coupon_yield == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @current_price = current_price unless current_price == SKIP
+      @daily_change = daily_change unless daily_change == SKIP
+      @description = description unless description == SKIP
+      @expiration = expiration unless expiration == SKIP
+      @face_value = face_value unless face_value == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @guid = guid unless guid == SKIP
+      @market_value = market_value unless market_value == SKIP
+      @maturity_date = maturity_date unless maturity_date == SKIP
+      @percentage_change = percentage_change unless percentage_change == SKIP
+      @purchase_price = purchase_price unless purchase_price == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @rate = rate unless rate == SKIP
+      @strike_price = strike_price unless strike_price == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @term = term unless term == SKIP
+      @today_ugl_amount = today_ugl_amount unless today_ugl_amount == SKIP
+      @today_ugl_percentage = today_ugl_percentage unless today_ugl_percentage == SKIP
+      @total_ugl_amount = total_ugl_amount unless total_ugl_amount == SKIP
+      @total_ugl_percentage = total_ugl_percentage unless total_ugl_percentage == SKIP
+      @unvested_quantity = unvested_quantity unless unvested_quantity == SKIP
+      @unvested_value = unvested_value unless unvested_value == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @vested_quantity = vested_quantity unless vested_quantity == SKIP
+      @vested_value = vested_value unless vested_value == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @current_price_as_of = current_price_as_of unless current_price_as_of == SKIP
+      @issue_date = issue_date unless issue_date == SKIP
+      @vesting_start_date = vesting_start_date unless vesting_start_date == SKIP
+      @vesting_end_date = vesting_end_date unless vesting_end_date == SKIP
+      @put_or_call = put_or_call unless put_or_call == SKIP
+      @holding_type = holding_type unless holding_type == SKIP
+      @term_unit = term_unit unless term_unit == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      cost_basis = hash.key?('cost_basis') ? hash['cost_basis'] : SKIP
+      coupon_yield = hash.key?('coupon_yield') ? hash['coupon_yield'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      current_price = hash.key?('current_price') ? hash['current_price'] : SKIP
+      daily_change = hash.key?('daily_change') ? hash['daily_change'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
+      face_value = hash.key?('face_value') ? hash['face_value'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      market_value = hash.key?('market_value') ? hash['market_value'] : SKIP
+      maturity_date = hash.key?('maturity_date') ? hash['maturity_date'] : SKIP
+      percentage_change =
+        hash.key?('percentage_change') ? hash['percentage_change'] : SKIP
+      purchase_price =
+        hash.key?('purchase_price') ? hash['purchase_price'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      rate = hash.key?('rate') ? hash['rate'] : SKIP
+      strike_price = hash.key?('strike_price') ? hash['strike_price'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      term = hash.key?('term') ? hash['term'] : SKIP
+      today_ugl_amount =
+        hash.key?('today_ugl_amount') ? hash['today_ugl_amount'] : SKIP
+      today_ugl_percentage =
+        hash.key?('today_ugl_percentage') ? hash['today_ugl_percentage'] : SKIP
+      total_ugl_amount =
+        hash.key?('total_ugl_amount') ? hash['total_ugl_amount'] : SKIP
+      total_ugl_percentage =
+        hash.key?('total_ugl_percentage') ? hash['total_ugl_percentage'] : SKIP
+      unvested_quantity =
+        hash.key?('unvested_quantity') ? hash['unvested_quantity'] : SKIP
+      unvested_value =
+        hash.key?('unvested_value') ? hash['unvested_value'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      vested_quantity =
+        hash.key?('vested_quantity') ? hash['vested_quantity'] : SKIP
+      vested_value = hash.key?('vested_value') ? hash['vested_value'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      current_price_as_of =
+        hash.key?('current_price_as_of') ? hash['current_price_as_of'] : SKIP
+      issue_date = hash.key?('issue_date') ? hash['issue_date'] : SKIP
+      vesting_start_date =
+        hash.key?('vesting_start_date') ? hash['vesting_start_date'] : SKIP
+      vesting_end_date =
+        hash.key?('vesting_end_date') ? hash['vesting_end_date'] : SKIP
+      put_or_call = hash.key?('put_or_call') ? hash['put_or_call'] : SKIP
+      holding_type = hash.key?('holding_type') ? hash['holding_type'] : SKIP
+      term_unit = hash.key?('term_unit') ? hash['term_unit'] : 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.
+      InvestmentHoldingResponse.new(account_guid: account_guid,
+                                    cost_basis: cost_basis,
+                                    coupon_yield: coupon_yield,
+                                    currency_code: currency_code,
+                                    current_price: current_price,
+                                    daily_change: daily_change,
+                                    description: description,
+                                    expiration: expiration,
+                                    face_value: face_value,
+                                    frequency: frequency,
+                                    guid: guid,
+                                    market_value: market_value,
+                                    maturity_date: maturity_date,
+                                    percentage_change: percentage_change,
+                                    purchase_price: purchase_price,
+                                    quantity: quantity,
+                                    rate: rate,
+                                    strike_price: strike_price,
+                                    symbol: symbol,
+                                    term: term,
+                                    today_ugl_amount: today_ugl_amount,
+                                    today_ugl_percentage: today_ugl_percentage,
+                                    total_ugl_amount: total_ugl_amount,
+                                    total_ugl_percentage: total_ugl_percentage,
+                                    unvested_quantity: unvested_quantity,
+                                    unvested_value: unvested_value,
+                                    user_guid: user_guid,
+                                    vested_quantity: vested_quantity,
+                                    vested_value: vested_value,
+                                    created_at: created_at,
+                                    current_price_as_of: current_price_as_of,
+                                    issue_date: issue_date,
+                                    vesting_start_date: vesting_start_date,
+                                    vesting_end_date: vesting_end_date,
+                                    put_or_call: put_or_call,
+                                    holding_type: holding_type,
+                                    term_unit: term_unit,
+                                    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} account_guid: #{@account_guid}, cost_basis: #{@cost_basis}, coupon_yield:"\
+      " #{@coupon_yield}, currency_code: #{@currency_code}, current_price: #{@current_price},"\
+      " daily_change: #{@daily_change}, description: #{@description}, expiration: #{@expiration},"\
+      " face_value: #{@face_value}, frequency: #{@frequency}, guid: #{@guid}, market_value:"\
+      " #{@market_value}, maturity_date: #{@maturity_date}, percentage_change:"\
+      " #{@percentage_change}, purchase_price: #{@purchase_price}, quantity: #{@quantity}, rate:"\
+      " #{@rate}, strike_price: #{@strike_price}, symbol: #{@symbol}, term: #{@term},"\
+      " today_ugl_amount: #{@today_ugl_amount}, today_ugl_percentage: #{@today_ugl_percentage},"\
+      " total_ugl_amount: #{@total_ugl_amount}, total_ugl_percentage: #{@total_ugl_percentage},"\
+      " unvested_quantity: #{@unvested_quantity}, unvested_value: #{@unvested_value}, user_guid:"\
+      " #{@user_guid}, vested_quantity: #{@vested_quantity}, vested_value: #{@vested_value},"\
+      " created_at: #{@created_at}, current_price_as_of: #{@current_price_as_of}, issue_date:"\
+      " #{@issue_date}, vesting_start_date: #{@vesting_start_date}, vesting_end_date:"\
+      " #{@vesting_end_date}, put_or_call: #{@put_or_call}, holding_type: #{@holding_type},"\
+      " term_unit: #{@term_unit}, 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} account_guid: #{@account_guid.inspect}, cost_basis: #{@cost_basis.inspect},"\
+      " coupon_yield: #{@coupon_yield.inspect}, currency_code: #{@currency_code.inspect},"\
+      " current_price: #{@current_price.inspect}, daily_change: #{@daily_change.inspect},"\
+      " description: #{@description.inspect}, expiration: #{@expiration.inspect}, face_value:"\
+      " #{@face_value.inspect}, frequency: #{@frequency.inspect}, guid: #{@guid.inspect},"\
+      " market_value: #{@market_value.inspect}, maturity_date: #{@maturity_date.inspect},"\
+      " percentage_change: #{@percentage_change.inspect}, purchase_price:"\
+      " #{@purchase_price.inspect}, quantity: #{@quantity.inspect}, rate: #{@rate.inspect},"\
+      " strike_price: #{@strike_price.inspect}, symbol: #{@symbol.inspect}, term:"\
+      " #{@term.inspect}, today_ugl_amount: #{@today_ugl_amount.inspect}, today_ugl_percentage:"\
+      " #{@today_ugl_percentage.inspect}, total_ugl_amount: #{@total_ugl_amount.inspect},"\
+      " total_ugl_percentage: #{@total_ugl_percentage.inspect}, unvested_quantity:"\
+      " #{@unvested_quantity.inspect}, unvested_value: #{@unvested_value.inspect}, user_guid:"\
+      " #{@user_guid.inspect}, vested_quantity: #{@vested_quantity.inspect}, vested_value:"\
+      " #{@vested_value.inspect}, created_at: #{@created_at.inspect}, current_price_as_of:"\
+      " #{@current_price_as_of.inspect}, issue_date: #{@issue_date.inspect}, vesting_start_date:"\
+      " #{@vesting_start_date.inspect}, vesting_end_date: #{@vesting_end_date.inspect},"\
+      " put_or_call: #{@put_or_call.inspect}, holding_type: #{@holding_type.inspect}, term_unit:"\
+      " #{@term_unit.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/investment_holding_response_body.rb

@@ -0,0 +1,77 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InvestmentHoldingResponseBody Model.
+  class InvestmentHoldingResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [InvestmentHoldingResponse]
+    attr_accessor :investment_holding
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['investment_holding'] = 'investment_holding'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        investment_holding
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(investment_holding: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @investment_holding = investment_holding unless investment_holding == 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.
+      investment_holding = InvestmentHoldingResponse.from_hash(hash['investment_holding']) if
+        hash['investment_holding']
+
+      # 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.
+      InvestmentHoldingResponseBody.new(investment_holding: investment_holding,
+                                        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} investment_holding: #{@investment_holding}, 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} investment_holding: #{@investment_holding.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/investment_holdings_deactivation.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InvestmentHoldingsDeactivation Model.
+  class InvestmentHoldingsDeactivation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message: SKIP, status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message unless message == SKIP
+      @status = status unless status == 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.
+      message = hash.key?('message') ? hash['message'] : SKIP
+      status = hash.key?('status') ? hash['status'] : 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.
+      InvestmentHoldingsDeactivation.new(message: message,
+                                         status: status,
+                                         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} message: #{@message}, status: #{@status}, 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} message: #{@message.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end