Class: Pago::V2026_04::Models::CustomerSessionCustomerExternalIDCreate

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

Overview

Schema for creating a customer session using an external customer ID.

Constant Summary collapse

JSON_KEYS =

Returns:

  • (Hash[Symbol, String]) 
{
  member_id: "member_id",
  external_member_id: "external_member_id",
  return_url: "return_url",
  external_customer_id: "external_customer_id"
}.freeze
REQUIRED_KEYS =

Returns:

  • (Array[String]) 
["external_customer_id"].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(member_id: ::Pago::UNSET, external_member_id: ::Pago::UNSET, return_url: ::Pago::UNSET, external_customer_id:) ⇒ CustomerSessionCustomerExternalIDCreate

Returns a new instance of CustomerSessionCustomerExternalIDCreate.

Parameters:

  • member_id: (String, nil) (defaults to: ::Pago::UNSET)
  • external_member_id: (String, nil) (defaults to: ::Pago::UNSET)
  • return_url: (String, nil) (defaults to: ::Pago::UNSET)
  • external_customer_id: (String) 


19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
 
# File 'lib/pago/v2026_04/models.rb', line 19830

def initialize(
  member_id: ::Pago::UNSET,
  external_member_id: ::Pago::UNSET,
  return_url: ::Pago::UNSET,
  external_customer_id:
)
  super()
  assign(:member_id, member_id)
  assign(:external_member_id, external_member_id)
  assign(:return_url, return_url)
  assign(:external_customer_id, external_customer_id)
end

Instance Attribute Details

#external_customer_id ⇒ String (readonly)

External ID of the customer to create a session for.

Returns:

  • (String) 


19828
19829
19830
 
# File 'lib/pago/v2026_04/models.rb', line 19828

def external_customer_id
  @external_customer_id
end

#external_member_id ⇒ String? (readonly)

External ID of the member to create a session for. Alternative to member_id.

Returns:

  • (String, nil) 


19820
19821
19822
 
# File 'lib/pago/v2026_04/models.rb', line 19820

def external_member_id
  @external_member_id
end

#member_id ⇒ String? (readonly)

ID of the member to create a session for. When not provided and the organization has member_model_enabled, the owner member of the customer will be used for individual customers.

Returns:

  • (String, nil) 


19816
19817
19818
 
# File 'lib/pago/v2026_04/models.rb', line 19816

def member_id
  @member_id
end

#return_url ⇒ String? (readonly)

When set, a back button will be shown in the customer portal to return to this URL.

Returns:

  • (String, nil) 


19824
19825
19826
 
# File 'lib/pago/v2026_04/models.rb', line 19824

def return_url
  @return_url
end

Class Method Details

.from_json(data) ⇒ CustomerSessionCustomerExternalIDCreate?

Parameters:

  • data (Hash, String, nil)

Returns:



19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
 
# File 'lib/pago/v2026_04/models.rb', line 19845

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(
      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),
      return_url: (data.key?("return_url") ? data["return_url"] : ::Pago::UNSET),
      external_customer_id: (data.key?("external_customer_id") ? data["external_customer_id"] : ::Pago::UNSET)
    ),
    data
  )
end