Class: WhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb

Overview

See Also:

Defined Under Namespace

Modules: Status Classes: BusinessAddress, LinkedCompany, PersonalAddress, Verification

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(city:, country:, line1:, line2:, postal_code:, state:) ⇒ Object

Residential address reported by the identity provider. Present on ‘individual` profiles.

Parameters:

  • city (String, nil)

    The city of the address.

  • country (String, nil)

    The country of the address.

  • line1 (String, nil)

    The line 1 of the address.

  • line2 (String, nil)

    The line 2 of the address.

  • postal_code (String, nil)

    The postal code of the address.

  • state (String, nil)

    The state of the address.



# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 181

Instance Attribute Details

#business_addressWhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data::BusinessAddress?

Registered business address reported by the identity provider. Present on ‘business` profiles.



72
73
74
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 72

required :business_address,
-> { WhopSDK::IdentityProfileNeedsActionWebhookEvent::Data::BusinessAddress },
nil?: true

#business_nameString?

Business entity name. Present on ‘business` profiles.

Returns:

  • (String, nil)


80
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 80

required :business_name, String, nil?: true

#business_structureString?

Reported legal structure of a business profile (e.g. ‘corp`, `llc`). Provider-specific values; present on `business` profiles.

Returns:

  • (String, nil)


87
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 87

required :business_structure, String, nil?: true

#countryString?

ISO 3166-1 alpha-3 country code (e.g. ‘USA`, `GBR`). For individuals this is the country of citizenship or residence reported by the identity provider; for businesses this is the country of incorporation.

Returns:

  • (String, nil)


95
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 95

required :country, String, nil?: true

#created_atTime

When the identity profile was first created.

Returns:

  • (Time)


101
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 101

required :created_at, Time

#date_of_birthString?

ISO date (‘YYYY-MM-DD`) reported by the identity provider. Present on `individual` profiles.

Returns:

  • (String, nil)


108
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 108

required :date_of_birth, String, nil?: true

#emailString?

Email address reported by the identity provider. Typically present on ‘individual` profiles.

Returns:

  • (String, nil)


115
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 115

required :email, String, nil?: true

#first_nameString?

Individual’s first name.

Returns:

  • (String, nil)


121
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 121

required :first_name, String, nil?: true

#idString

The tag of the identity profile (idpf_xxx).

Returns:

  • (String)


65
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 65

required :id, String

#last_nameString?

Individual’s last name.

Returns:

  • (String, nil)


127
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 127

required :last_name, String, nil?: true

#linked_companiesArray<WhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data::LinkedCompany>

The companies this identity profile is currently linked to. Only populated for direct Whop user sessions; always empty when authenticated via API key, app, or OAuth scope (a single identity can be linked to companies the calling platform is not entitled to see).



136
137
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 136

required :linked_companies,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::IdentityProfileNeedsActionWebhookEvent::Data::LinkedCompany] }

#personal_addressWhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data::PersonalAddress?

Residential address reported by the identity provider. Present on ‘individual` profiles.



144
145
146
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 144

required :personal_address,
-> { WhopSDK::IdentityProfileNeedsActionWebhookEvent::Data::PersonalAddress },
nil?: true

#phoneString?

Phone number reported by the identity provider. Typically present on ‘individual` profiles.

Returns:

  • (String, nil)


153
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 153

required :phone, String, nil?: true

#profile_typeString

Whether this is an ‘individual’ or ‘business’ profile.

Returns:

  • (String)


159
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 159

required :profile_type, String

#statusSymbol, WhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data::Status

Derived verification status across all linked verifications.



165
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 165

required :status, enum: -> { WhopSDK::IdentityProfileNeedsActionWebhookEvent::Data::Status }

#updated_atTime

When the identity profile was last synced from a verification.

Returns:

  • (Time)


171
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 171

required :updated_at, Time

#verificationsArray<WhopSDK::Models::IdentityProfileNeedsActionWebhookEvent::Data::Verification>

All verification attempts attached to this identity profile, ordered most-recent first.



178
179
# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 178

required :verifications,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::IdentityProfileNeedsActionWebhookEvent::Data::Verification] }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb', line 366