Class: Pago::V2026_04::Models::CustomerTeam

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

Overview

A team customer in an organization.

Constant Summary collapse

JSON_KEYS =

Returns:

  • (Hash[Symbol, String]) 
{
  id: "id",
  created_at: "created_at",
  modified_at: "modified_at",
  metadata: "metadata",
  external_id: "external_id",
  email: "email",
  email_verified: "email_verified",
  type: "type",
  name: "name",
  billing_name: "billing_name",
  billing_address: "billing_address",
  tax_id: "tax_id",
  locale: "locale",
  organization_id: "organization_id",
  default_payment_method_id: "default_payment_method_id",
  deleted_at: "deleted_at",
  avatar_url: "avatar_url"
}.freeze
REQUIRED_KEYS =

Returns:

  • (Array[String]) 
["id", "created_at", "modified_at", "metadata", "email_verified", "type", "name", "billing_name", "billing_address", "tax_id", "organization_id", "deleted_at", "avatar_url"].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:, created_at:, modified_at:, metadata:, external_id: ::Pago::UNSET, email: ::Pago::UNSET, email_verified:, type:, name:, billing_name:, billing_address:, tax_id:, locale: ::Pago::UNSET, organization_id:, default_payment_method_id: ::Pago::UNSET, deleted_at:, avatar_url:) ⇒ CustomerTeam

Returns a new instance of CustomerTeam.

Parameters:

  • id: (String)
  • created_at: (String)
  • modified_at: (String, nil)
  • metadata: (Hash[String, untyped])
  • external_id: (String, nil) (defaults to: ::Pago::UNSET)
  • email: (String, nil) (defaults to: ::Pago::UNSET)
  • email_verified: (Boolean)
  • type: (String)
  • name: (String, nil)
  • billing_name: (String, nil)
  • billing_address: (Models::Address, nil)
  • tax_id: (Array[untyped], nil)
  • locale: (String, nil) (defaults to: ::Pago::UNSET)
  • organization_id: (String)
  • default_payment_method_id: (String, nil) (defaults to: ::Pago::UNSET)
  • deleted_at: (String, nil)
  • avatar_url: (String, nil) 


21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
 
# File 'lib/pago/v2026_04/models.rb', line 21657

def initialize(
  id:,
  created_at:,
  modified_at:,
  metadata:,
  external_id: ::Pago::UNSET,
  email: ::Pago::UNSET,
  email_verified:,
  type:,
  name:,
  billing_name:,
  billing_address:,
  tax_id:,
  locale: ::Pago::UNSET,
  organization_id:,
  default_payment_method_id: ::Pago::UNSET,
  deleted_at:,
  avatar_url:
)
  super()
  assign(:id, id)
  assign(:created_at, created_at)
  assign(:modified_at, modified_at)
  assign(:metadata, metadata)
  assign(:external_id, external_id)
  assign(:email, email)
  assign(:email_verified, email_verified)
  assign(:type, type)
  assign(:name, name)
  assign(:billing_name, billing_name)
  assign(:billing_address, billing_address)
  assign(:tax_id, tax_id)
  assign(:locale, locale)
  assign(:organization_id, organization_id)
  assign(:default_payment_method_id, default_payment_method_id)
  assign(:deleted_at, deleted_at)
  assign(:avatar_url, avatar_url)
end

Instance Attribute Details

#avatar_url ⇒ String? (readonly)

Returns:

  • (String, nil) 


21655
21656
21657
 
# File 'lib/pago/v2026_04/models.rb', line 21655

def avatar_url
  @avatar_url
end

#billing_address ⇒ Models::Address? (readonly)

Returns:



21634
21635
21636
 
# File 'lib/pago/v2026_04/models.rb', line 21634

def billing_address
  @billing_address
end

#billing_name ⇒ String? (readonly)

The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.

Returns:

  • (String, nil) 


21631
21632
21633
 
# File 'lib/pago/v2026_04/models.rb', line 21631

def billing_name
  @billing_name
end

#created_at ⇒ String (readonly)

Creation timestamp of the object.

Returns:

  • (String) 


21600
21601
21602
 
# File 'lib/pago/v2026_04/models.rb', line 21600

def created_at
  @created_at
end

#default_payment_method_id ⇒ String? (readonly)

The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.

Returns:

  • (String, nil) 


21648
21649
21650
 
# File 'lib/pago/v2026_04/models.rb', line 21648

def default_payment_method_id
  @default_payment_method_id
end

#deleted_at ⇒ String? (readonly)

Timestamp for when the customer was soft deleted.

Returns:

  • (String, nil) 


21652
21653
21654
 
# File 'lib/pago/v2026_04/models.rb', line 21652

def deleted_at
  @deleted_at
end

#email ⇒ String? (readonly)

The email address of the customer. This must be unique within the organization.

Returns:

  • (String, nil) 


21615
21616
21617
 
# File 'lib/pago/v2026_04/models.rb', line 21615

def email
  @email
end

#email_verified ⇒ Boolean (readonly)

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Returns:

  • (Boolean) 


21619
21620
21621
 
# File 'lib/pago/v2026_04/models.rb', line 21619

def email_verified
  @email_verified
end

#external_id ⇒ String? (readonly)

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Returns:

  • (String, nil) 


21611
21612
21613
 
# File 'lib/pago/v2026_04/models.rb', line 21611

def external_id
  @external_id
end

#id ⇒ String (readonly)

The ID of the customer.

Returns:

  • (String) 


21596
21597
21598
 
# File 'lib/pago/v2026_04/models.rb', line 21596

def id
  @id
end

#locale ⇒ String? (readonly)

Returns:

  • (String, nil) 


21640
21641
21642
 
# File 'lib/pago/v2026_04/models.rb', line 21640

def locale
  @locale
end

#metadata ⇒ Hash{String => String, Integer, Float, Boolean} (readonly)

Returns:

  • (Hash{String => String, Integer, Float, Boolean}) 


21607
21608
21609
 
# File 'lib/pago/v2026_04/models.rb', line 21607

def metadata
  @metadata
end

#modified_at ⇒ String? (readonly)

Last modification timestamp of the object.

Returns:

  • (String, nil) 


21604
21605
21606
 
# File 'lib/pago/v2026_04/models.rb', line 21604

def modified_at
  @modified_at
end

#name ⇒ String? (readonly)

The name of the customer.

Returns:

  • (String, nil) 


21627
21628
21629
 
# File 'lib/pago/v2026_04/models.rb', line 21627

def name
  @name
end

#organization_id ⇒ String (readonly)

The ID of the organization owning the customer.

Returns:

  • (String) 


21644
21645
21646
 
# File 'lib/pago/v2026_04/models.rb', line 21644

def organization_id
  @organization_id
end

#tax_id ⇒ Array<Object>? (readonly)

Returns:

  • (Array<Object>, nil) 


21637
21638
21639
 
# File 'lib/pago/v2026_04/models.rb', line 21637

def tax_id
  @tax_id
end

#type ⇒ String (readonly)

The type of customer. Team customers can have multiple members.

Returns:

  • (String) 


21623
21624
21625
 
# File 'lib/pago/v2026_04/models.rb', line 21623

def type
  @type
end

Class Method Details

.from_json(data) ⇒ CustomerTeam?

Parameters:

  • data (Hash, String, nil)

Returns:



21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
 
# File 'lib/pago/v2026_04/models.rb', line 21698

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),
      created_at: (data.key?("created_at") ? data["created_at"] : ::Pago::UNSET),
      modified_at: (data.key?("modified_at") ? data["modified_at"] : ::Pago::UNSET),
      metadata: (data.key?("metadata") ? data["metadata"] : ::Pago::UNSET),
      external_id: (data.key?("external_id") ? data["external_id"] : ::Pago::UNSET),
      email: (data.key?("email") ? data["email"] : ::Pago::UNSET),
      email_verified: (data.key?("email_verified") ? data["email_verified"] : ::Pago::UNSET),
      type: (data.key?("type") ? data["type"] : ::Pago::UNSET),
      name: (data.key?("name") ? data["name"] : ::Pago::UNSET),
      billing_name: (data.key?("billing_name") ? data["billing_name"] : ::Pago::UNSET),
      billing_address: (data.key?("billing_address") ? Models::Address.from_json(data["billing_address"]) : ::Pago::UNSET),
      tax_id: (data.key?("tax_id") ? data["tax_id"] : ::Pago::UNSET),
      locale: (data.key?("locale") ? data["locale"] : ::Pago::UNSET),
      organization_id: (data.key?("organization_id") ? data["organization_id"] : ::Pago::UNSET),
      default_payment_method_id: (data.key?("default_payment_method_id") ? data["default_payment_method_id"] : ::Pago::UNSET),
      deleted_at: (data.key?("deleted_at") ? data["deleted_at"] : ::Pago::UNSET),
      avatar_url: (data.key?("avatar_url") ? data["avatar_url"] : ::Pago::UNSET)
    ),
    data
  )
end