orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/increment_credit_ledger_entry_invoice_settings.rb

@@ -0,0 +1,197 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # IncrementCreditLedgerEntryInvoiceSettings Model.
+  class IncrementCreditLedgerEntryInvoiceSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the credits purchase invoice should auto collect with the
+    # customer's saved payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # The net terms determines the due date of the invoice. Due date is
+    # calculated based on the invoice or issuance date, depending on the
+    # account's configured due date calculation method. A value of '0' here
+    # represents that the invoice is due on issue, whereas a value of '30'
+    # represents that the customer has 30 days to pay the invoice. You must set
+    # either `net_terms` or `custom_due_date`, but not both.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional memo to display on the invoice.
+    # @return [String]
+    attr_accessor :memo
+
+    # If true, the new credit block will require that the corresponding invoice
+    # is paid before it can be drawn down from.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_successful_payment
+
+    # An ISO 8601 format date that denotes when this invoice should be dated in
+    # the customer's timezone. If not provided, the invoice date will default to
+    # the credit block's effective date.
+    # @return [Object]
+    attr_accessor :invoice_date
+
+    # An optional custom due date for the invoice. If not set, the due date will
+    # be calculated based on the `net_terms` value.
+    # @return [Object]
+    attr_accessor :custom_due_date
+
+    # The ID of the Item to be used for the invoice line item. If not provided,
+    # a default 'Credits' item will be used.
+    # @return [String]
+    attr_accessor :item_id
+
+    # If true, the new credits purchase invoice will be marked as paid.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_as_paid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['memo'] = 'memo'
+      @_hash['require_successful_payment'] = 'require_successful_payment'
+      @_hash['invoice_date'] = 'invoice_date'
+      @_hash['custom_due_date'] = 'custom_due_date'
+      @_hash['item_id'] = 'item_id'
+      @_hash['mark_as_paid'] = 'mark_as_paid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        net_terms
+        memo
+        require_successful_payment
+        invoice_date
+        custom_due_date
+        item_id
+        mark_as_paid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        net_terms
+        memo
+        invoice_date
+        custom_due_date
+        item_id
+      ]
+    end
+
+    def initialize(auto_collection:, net_terms: SKIP, memo: SKIP,
+                   require_successful_payment: false, invoice_date: SKIP,
+                   custom_due_date: SKIP, item_id: SKIP, mark_as_paid: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto_collection = auto_collection
+      @net_terms = net_terms unless net_terms == SKIP
+      @memo = memo unless memo == SKIP
+      unless require_successful_payment == SKIP
+        @require_successful_payment =
+          require_successful_payment
+      end
+      @invoice_date = invoice_date unless invoice_date == SKIP
+      @custom_due_date = custom_due_date unless custom_due_date == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @mark_as_paid = mark_as_paid unless mark_as_paid == 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.
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      require_successful_payment = hash['require_successful_payment'] ||= false
+      invoice_date = hash.key?('invoice_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:IncrementCreditLedgerEntryInvoiceSettingsInvoiceDate), hash['invoice_date']
+      ) : SKIP
+      custom_due_date = hash.key?('custom_due_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:IncrementCreditLedgerEntryInvoiceSettingsCustomDueDate), hash['custom_due_date']
+      ) : SKIP
+      item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
+      mark_as_paid = hash['mark_as_paid'] ||= false
+
+      # 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.
+      IncrementCreditLedgerEntryInvoiceSettings.new(auto_collection: auto_collection,
+                                                    net_terms: net_terms,
+                                                    memo: memo,
+                                                    require_successful_payment: require_successful_payment,
+                                                    invoice_date: invoice_date,
+                                                    custom_due_date: custom_due_date,
+                                                    item_id: item_id,
+                                                    mark_as_paid: mark_as_paid,
+                                                    additional_properties: additional_properties)
+    end
+
+    def to_union_type_invoice_date
+      UnionTypeLookUp.get(:IncrementCreditLedgerEntryInvoiceSettingsInvoiceDate)
+                     .validate(invoice_date)
+                     .serialize(invoice_date)
+    end
+
+    def to_union_type_custom_due_date
+      UnionTypeLookUp.get(:IncrementCreditLedgerEntryInvoiceSettingsCustomDueDate)
+                     .validate(custom_due_date)
+                     .serialize(custom_due_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IncrementCreditLedgerEntryInvoiceSettings | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.auto_collection,
+                                     ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['auto_collection'],
+                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto_collection: #{@auto_collection}, net_terms: #{@net_terms}, memo:"\
+      " #{@memo}, require_successful_payment: #{@require_successful_payment}, invoice_date:"\
+      " #{@invoice_date}, custom_due_date: #{@custom_due_date}, item_id: #{@item_id},"\
+      " mark_as_paid: #{@mark_as_paid}, 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} auto_collection: #{@auto_collection.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, memo: #{@memo.inspect}, require_successful_payment:"\
+      " #{@require_successful_payment.inspect}, invoice_date: #{@invoice_date.inspect},"\
+      " custom_due_date: #{@custom_due_date.inspect}, item_id: #{@item_id.inspect}, mark_as_paid:"\
+      " #{@mark_as_paid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/increment_ledger_entry.rb

@@ -0,0 +1,322 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # IncrementLedgerEntry Model.
+  class IncrementLedgerEntry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :id
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Integer]
+    attr_accessor :ledger_sequence_number
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [EntryStatus]
+    attr_accessor :entry_status
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :starting_balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :ending_balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :currency
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :description
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [AffectedBlock]
+    attr_accessor :credit_block
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_reader :entry_type
+
+    # If the increment resulted in invoice creation, the list of created
+    # invoices
+    # @return [Array[Invoice]]
+    attr_accessor :created_invoices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['ledger_sequence_number'] = 'ledger_sequence_number'
+      @_hash['entry_status'] = 'entry_status'
+      @_hash['customer'] = 'customer'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['ending_balance'] = 'ending_balance'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['credit_block'] = 'credit_block'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['created_invoices'] = 'created_invoices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_invoices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        created_invoices
+      ]
+    end
+
+    def initialize(metadata:, id:, ledger_sequence_number:, entry_status:,
+                   customer:, starting_balance:, ending_balance:, amount:,
+                   currency:, created_at:, description:, credit_block:,
+                   created_invoices: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @ledger_sequence_number = ledger_sequence_number
+      @entry_status = entry_status
+      @customer = customer
+      @starting_balance = starting_balance
+      @ending_balance = ending_balance
+      @amount = amount
+      @currency = currency
+      @created_at = created_at
+      @description = description
+      @credit_block = credit_block
+      @entry_type = 'increment'
+      @created_invoices = created_invoices unless created_invoices == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      ledger_sequence_number =
+        hash.key?('ledger_sequence_number') ? hash['ledger_sequence_number'] : nil
+      entry_status = hash.key?('entry_status') ? hash['entry_status'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      starting_balance =
+        hash.key?('starting_balance') ? hash['starting_balance'] : nil
+      ending_balance =
+        hash.key?('ending_balance') ? hash['ending_balance'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      description = hash.key?('description') ? hash['description'] : nil
+      credit_block = AffectedBlock.from_hash(hash['credit_block']) if hash['credit_block']
+      # Parameter is an array, so we need to iterate through it
+      created_invoices = nil
+      unless hash['created_invoices'].nil?
+        created_invoices = []
+        hash['created_invoices'].each do |structure|
+          created_invoices << (Invoice.from_hash(structure) if structure)
+        end
+      end
+
+      created_invoices = SKIP unless hash.key?('created_invoices')
+
+      # 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.
+      IncrementLedgerEntry.new(metadata: metadata,
+                               id: id,
+                               ledger_sequence_number: ledger_sequence_number,
+                               entry_status: entry_status,
+                               customer: customer,
+                               starting_balance: starting_balance,
+                               ending_balance: ending_balance,
+                               amount: amount,
+                               currency: currency,
+                               created_at: created_at,
+                               description: description,
+                               credit_block: credit_block,
+                               created_invoices: created_invoices,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IncrementLedgerEntry | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.metadata,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ledger_sequence_number,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.entry_status,
+                                  ->(val) { EntryStatus.validate(val) }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.starting_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.ending_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_block,
+                                  ->(val) { AffectedBlock.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.entry_type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['metadata'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ledger_sequence_number'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['entry_status'],
+                                ->(val) { EntryStatus.validate(val) }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['starting_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['ending_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_block'],
+                                ->(val) { AffectedBlock.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['entry_type'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, id: #{@id}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number}, entry_status: #{@entry_status}, customer: #{@customer},"\
+      " starting_balance: #{@starting_balance}, ending_balance: #{@ending_balance}, amount:"\
+      " #{@amount}, currency: #{@currency}, created_at: #{@created_at}, description:"\
+      " #{@description}, credit_block: #{@credit_block}, entry_type: #{@entry_type},"\
+      " created_invoices: #{@created_invoices}, 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} metadata: #{@metadata.inspect}, id: #{@id.inspect}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number.inspect}, entry_status: #{@entry_status.inspect}, customer:"\
+      " #{@customer.inspect}, starting_balance: #{@starting_balance.inspect}, ending_balance:"\
+      " #{@ending_balance.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " created_at: #{@created_at.inspect}, description: #{@description.inspect}, credit_block:"\
+      " #{@credit_block.inspect}, entry_type: #{@entry_type.inspect}, created_invoices:"\
+      " #{@created_invoices.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/ingest_event.rb

@@ -0,0 +1,127 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # IngestEvent Model.
+  class IngestEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Orb Customer identifier
+    # @return [String]
+    attr_accessor :customer_id
+
+    # An alias for the Orb customer, whose mapping is specified when creating
+    # the customer
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # A name to meaningfully identify the action or event type.
+    # @return [String]
+    attr_accessor :event_name
+
+    # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+    # represent the time that usage was recorded, and is particularly important
+    # to attribute usage to a given billing period.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # A dictionary of custom properties. Values in this dictionary must be
+    # numeric, boolean, or strings. Nested dictionaries are disallowed.
+    # @return [Object]
+    attr_accessor :properties
+
+    # A unique value, generated by the client, that is used to de-duplicate
+    # events. Exactly one event with a given idempotency key will be ingested,
+    # which allows for safe request retries.
+    # @return [String]
+    attr_accessor :idempotency_key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['event_name'] = 'event_name'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['properties'] = 'properties'
+      @_hash['idempotency_key'] = 'idempotency_key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_id
+        external_customer_id
+      ]
+    end
+
+    def initialize(event_name:, timestamp:, properties:, idempotency_key:,
+                   customer_id: SKIP, external_customer_id: SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @event_name = event_name
+      @timestamp = timestamp
+      @properties = properties
+      @idempotency_key = idempotency_key
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      event_name = hash.key?('event_name') ? hash['event_name'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      properties = hash.key?('properties') ? hash['properties'] : nil
+      idempotency_key =
+        hash.key?('idempotency_key') ? hash['idempotency_key'] : nil
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      IngestEvent.new(event_name: event_name,
+                      timestamp: timestamp,
+                      properties: properties,
+                      idempotency_key: idempotency_key,
+                      customer_id: customer_id,
+                      external_customer_id: external_customer_id)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id}, external_customer_id:"\
+      " #{@external_customer_id}, event_name: #{@event_name}, timestamp: #{@timestamp},"\
+      " properties: #{@properties}, idempotency_key: #{@idempotency_key}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, event_name: #{@event_name.inspect}, timestamp:"\
+      " #{@timestamp.inspect}, properties: #{@properties.inspect}, idempotency_key:"\
+      " #{@idempotency_key.inspect}>"
+    end
+  end
+end