Class: Pago::V2026_04::Models::BalanceCreditOrderEvent

Inherits:
Model
  • Object
show all
Defined in:
lib/pago/v2026_04/models.rb,
sig/pago/v2026_04/generated.rbs

Overview

An event created by Pago when an order is paid via customer balance.

Constant Summary collapse

JSON_KEYS =

Returns:

  • (Hash[Symbol, String]) 
{
  id: "id",
  timestamp: "timestamp",
  organization_id: "organization_id",
  customer_id: "customer_id",
  customer: "customer",
  external_customer_id: "external_customer_id",
  member_id: "member_id",
  external_member_id: "external_member_id",
  child_count: "child_count",
  parent_id: "parent_id",
  label: "label",
  source: "source",
  name: "name",
  metadata: "metadata"
}.freeze
REQUIRED_KEYS =

Returns:

  • (Array[String]) 
["id", "timestamp", "organization_id", "customer_id", "customer", "external_customer_id", "label", "source", "name", "metadata"].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

#==, #[], #field_set?, #hash, #inspect, json_keys, required_json_keys, #to_json, #to_json_hash, wrap_raw

Constructor Details

#initialize(id:, timestamp:, organization_id:, customer_id:, customer:, external_customer_id:, member_id: ::Pago::UNSET, external_member_id: ::Pago::UNSET, child_count: ::Pago::UNSET, parent_id: ::Pago::UNSET, label:, source:, name:, metadata:) ⇒ BalanceCreditOrderEvent

Returns a new instance of BalanceCreditOrderEvent.

Parameters:

  • id: (String)
  • timestamp: (String)
  • organization_id: (String)
  • customer_id: (String, nil)
  • customer: (Object)
  • external_customer_id: (String, nil)
  • member_id: (String, nil) (defaults to: ::Pago::UNSET)
  • external_member_id: (String, nil) (defaults to: ::Pago::UNSET)
  • child_count: (Integer, nil) (defaults to: ::Pago::UNSET)
  • parent_id: (String, nil) (defaults to: ::Pago::UNSET)
  • label: (String)
  • source: (String)
  • name: (String)
  • metadata: (Models::BalanceCreditOrderMetadata) 


742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/pago/v2026_04/models.rb', line 742

def initialize(
  id:,
  timestamp:,
  organization_id:,
  customer_id:,
  customer:,
  external_customer_id:,
  member_id: ::Pago::UNSET,
  external_member_id: ::Pago::UNSET,
  child_count: ::Pago::UNSET,
  parent_id: ::Pago::UNSET,
  label:,
  source:,
  name:,
  metadata:
)
  super()
  assign(:id, id)
  assign(:timestamp, timestamp)
  assign(:organization_id, organization_id)
  assign(:customer_id, customer_id)
  assign(:customer, customer)
  assign(:external_customer_id, external_customer_id)
  assign(:member_id, member_id)
  assign(:external_member_id, external_member_id)
  assign(:child_count, child_count)
  assign(:parent_id, parent_id)
  assign(:label, label)
  assign(:source, source)
  assign(:name, name)
  assign(:metadata, metadata)
end

Instance Attribute Details

#child_count ⇒ Integer (readonly)

Number of direct child events linked to this event.

Returns:

  • (Integer) 


721
722
723
 
# File 'lib/pago/v2026_04/models.rb', line 721

def child_count
  @child_count
end

#customer ⇒ Object? (readonly)

The customer associated with the event.

Returns:

  • (Object, nil) 


705
706
707
 
# File 'lib/pago/v2026_04/models.rb', line 705

def customer
  @customer
end

#customer_id ⇒ String? (readonly)

ID of the customer in your Pago organization associated with the event.

Returns:

  • (String, nil) 


701
702
703
 
# File 'lib/pago/v2026_04/models.rb', line 701

def customer_id
  @customer_id
end

#external_customer_id ⇒ String? (readonly)

ID of the customer in your system associated with the event.

Returns:

  • (String, nil) 


709
710
711
 
# File 'lib/pago/v2026_04/models.rb', line 709

def external_customer_id
  @external_customer_id
end

#external_member_id ⇒ String? (readonly)

ID of the member in your system within the customer's organization who performed the action inside B2B.

Returns:

  • (String, nil) 


717
718
719
 
# File 'lib/pago/v2026_04/models.rb', line 717

def external_member_id
  @external_member_id
end

#id ⇒ String (readonly)

The ID of the object.

Returns:

  • (String) 


689
690
691
 
# File 'lib/pago/v2026_04/models.rb', line 689

def id
  @id
end

#label ⇒ String (readonly)

Human readable label of the event type.

Returns:

  • (String) 


729
730
731
 
# File 'lib/pago/v2026_04/models.rb', line 729

def label
  @label
end

#member_id ⇒ String? (readonly)

ID of the member within the customer's organization who performed the action inside B2B.

Returns:

  • (String, nil) 


713
714
715
 
# File 'lib/pago/v2026_04/models.rb', line 713

def member_id
  @member_id
end

#metadata ⇒ Models::BalanceCreditOrderMetadata (readonly)

Returns:



740
741
742
 
# File 'lib/pago/v2026_04/models.rb', line 740

def metadata
  @metadata
end

#name ⇒ String (readonly)

The name of the event.

Returns:

  • (String) 


737
738
739
 
# File 'lib/pago/v2026_04/models.rb', line 737

def name
  @name
end

#organization_id ⇒ String (readonly)

The ID of the organization owning the event.

Returns:

  • (String) 


697
698
699
 
# File 'lib/pago/v2026_04/models.rb', line 697

def organization_id
  @organization_id
end

#parent_id ⇒ String? (readonly)

The ID of the parent event.

Returns:

  • (String, nil) 


725
726
727
 
# File 'lib/pago/v2026_04/models.rb', line 725

def parent_id
  @parent_id
end

#source ⇒ String (readonly)

The source of the event. system events are created by Pago. user events are the one you create through our ingestion API.

Returns:

  • (String) 


733
734
735
 
# File 'lib/pago/v2026_04/models.rb', line 733

def source
  @source
end

#timestamp ⇒ String (readonly)

The timestamp of the event.

Returns:

  • (String) 


693
694
695
 
# File 'lib/pago/v2026_04/models.rb', line 693

def timestamp
  @timestamp
end

Class Method Details

.from_json(data) ⇒ BalanceCreditOrderEvent?

Parameters:

  • data (Hash, String, nil)

Returns:



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/pago/v2026_04/models.rb', line 777

def self.from_json(data)
  data = ::JSON.parse(data) if data.is_a?(String)
  data = ::Pago::Serde.object(data)
  return nil if data.nil?

  wrap_raw(
    new(
      id: (data.key?("id") ? data["id"] : ::Pago::UNSET),
      timestamp: (data.key?("timestamp") ? data["timestamp"] : ::Pago::UNSET),
      organization_id: (data.key?("organization_id") ? data["organization_id"] : ::Pago::UNSET),
      customer_id: (data.key?("customer_id") ? data["customer_id"] : ::Pago::UNSET),
      customer: (data.key?("customer") ? Unions::Customer.from_json(data["customer"]) : ::Pago::UNSET),
      external_customer_id: (data.key?("external_customer_id") ? data["external_customer_id"] : ::Pago::UNSET),
      member_id: (data.key?("member_id") ? data["member_id"] : ::Pago::UNSET),
      external_member_id: (data.key?("external_member_id") ? data["external_member_id"] : ::Pago::UNSET),
      child_count: (data.key?("child_count") ? data["child_count"] : ::Pago::UNSET),
      parent_id: (data.key?("parent_id") ? data["parent_id"] : ::Pago::UNSET),
      label: (data.key?("label") ? data["label"] : ::Pago::UNSET),
      source: (data.key?("source") ? data["source"] : ::Pago::UNSET),
      name: (data.key?("name") ? data["name"] : ::Pago::UNSET),
      metadata: (data.key?("metadata") ? Models::BalanceCreditOrderMetadata.from_json(data["metadata"]) : ::Pago::UNSET)
    ),
    data
  )
end