Class: WhopSDK::Models::NotificationCreateParams::Body::SendNotificationV2InputWithCompanyID

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#company_id ⇒ String

The unique identifier of the company to target. Only team members of this company will receive the notification. Clicking the notification opens your dashboard app view.

Returns:

  • (String) 


38
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 38

required :company_id, String

#content ⇒ String

The main body text of the notification displayed to the user.

Returns:

  • (String) 


44
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 44

required :content, String

#icon_user_id ⇒ String?

The unique identifier of a user whose profile picture will be used as the notification icon. Defaults to the experience or company avatar when not provided.

Returns:

  • (String, nil) 


58
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 58

optional :icon_user_id, String, nil?: true

#rest_path ⇒ String?

A path segment appended to the generated deep link that opens your app. Use

restPath

in your app path configuration to read this parameter. For example,

‘/settings/billing’.

Returns:

  • (String, nil) 


66
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 66

optional :rest_path, String, nil?: true

#subtitle ⇒ String?

An optional secondary line of text displayed below the title in the notification.

Returns:

  • (String, nil) 


73
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 73

optional :subtitle, String, nil?: true

#title ⇒ String

The headline text of the notification, displayed prominently to the user.

Returns:

  • (String) 


50
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 50

required :title, String

#user_ids ⇒ Array<String>?

An optional list of user IDs to narrow the audience. When provided, only these users receive the notification, provided they are in the targeted experience or company.

Returns:

  • (Array<String>, nil) 


81
 
# File 'lib/whop_sdk/models/notification_create_params.rb', line 81

optional :user_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true