Class: Pago::V2026_04::Models::SubscriptionUncanceledEvent

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 a subscription cancellation is reversed.

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:) ⇒ SubscriptionUncanceledEvent

Returns a new instance of SubscriptionUncanceledEvent.

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::SubscriptionUncanceledMetadata) 


42520
42521
42522
42523
42524
42525
42526
42527
42528
42529
42530
42531
42532
42533
42534
42535
42536
42537
42538
42539
42540
42541
42542
42543
42544
42545
42546
42547
42548
42549
42550
42551
 
# File 'lib/pago/v2026_04/models.rb', line 42520

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) 


42499
42500
42501
 
# File 'lib/pago/v2026_04/models.rb', line 42499

def child_count
  @child_count
end

#customer ⇒ Object? (readonly)

The customer associated with the event.

Returns:

  • (Object, nil) 


42483
42484
42485
 
# File 'lib/pago/v2026_04/models.rb', line 42483

def customer
  @customer
end

#customer_id ⇒ String? (readonly)

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

Returns:

  • (String, nil) 


42479
42480
42481
 
# File 'lib/pago/v2026_04/models.rb', line 42479

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) 


42487
42488
42489
 
# File 'lib/pago/v2026_04/models.rb', line 42487

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) 


42495
42496
42497
 
# File 'lib/pago/v2026_04/models.rb', line 42495

def external_member_id
  @external_member_id
end

#id ⇒ String (readonly)

The ID of the object.

Returns:

  • (String) 


42467
42468
42469
 
# File 'lib/pago/v2026_04/models.rb', line 42467

def id
  @id
end

#label ⇒ String (readonly)

Human readable label of the event type.

Returns:

  • (String) 


42507
42508
42509
 
# File 'lib/pago/v2026_04/models.rb', line 42507

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) 


42491
42492
42493
 
# File 'lib/pago/v2026_04/models.rb', line 42491

def member_id
  @member_id
end

#metadata ⇒ Models::SubscriptionUncanceledMetadata (readonly)

Returns:



42518
42519
42520
 
# File 'lib/pago/v2026_04/models.rb', line 42518

def metadata
  @metadata
end

#name ⇒ String (readonly)

The name of the event.

Returns:

  • (String) 


42515
42516
42517
 
# File 'lib/pago/v2026_04/models.rb', line 42515

def name
  @name
end

#organization_id ⇒ String (readonly)

The ID of the organization owning the event.

Returns:

  • (String) 


42475
42476
42477
 
# File 'lib/pago/v2026_04/models.rb', line 42475

def organization_id
  @organization_id
end

#parent_id ⇒ String? (readonly)

The ID of the parent event.

Returns:

  • (String, nil) 


42503
42504
42505
 
# File 'lib/pago/v2026_04/models.rb', line 42503

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) 


42511
42512
42513
 
# File 'lib/pago/v2026_04/models.rb', line 42511

def source
  @source
end

#timestamp ⇒ String (readonly)

The timestamp of the event.

Returns:

  • (String) 


42471
42472
42473
 
# File 'lib/pago/v2026_04/models.rb', line 42471

def timestamp
  @timestamp
end

Class Method Details

.from_json(data) ⇒ SubscriptionUncanceledEvent?

Parameters:

  • data (Hash, String, nil)

Returns:



42555
42556
42557
42558
42559
42560
42561
42562
42563
42564
42565
42566
42567
42568
42569
42570
42571
42572
42573
42574
42575
42576
42577
42578
42579
 
# File 'lib/pago/v2026_04/models.rb', line 42555

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::SubscriptionUncanceledMetadata.from_json(data["metadata"]) : ::Pago::UNSET)
    ),
    data
  )
end