Class: WhopSDK::Models::ForumPostCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/forum_post_create_params.rb,
sig/whop_sdk/models/forum_post_create_params.rbs

Overview

See Also:

  • WhopSDK::Resources::ForumPosts#create

Defined Under Namespace

Classes: Attachment, Poll

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(id:) ⇒ Object

Input for an attachment

Parameters:

  • id (String) —

    The ID of an existing file object.




# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 140

Instance Attribute Details

#attachments ⇒ Array<WhopSDK::Models::ForumPostCreateParams::Attachment>?

A list of file attachments to include with the post, such as images or videos.

Parameters:

  • value (::Array[WhopSDK::ForumPostCreateParams::Attachment], nil)

Returns:



22
23
24
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 22

optional :attachments,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostCreateParams::Attachment] },
nil?: true

#company_id ⇒ String?

The unique identifier of the company whose public forum to post in. Required when experience_id is 'public'. For example, 'biz_xxxxx'.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


31
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 31

optional :company_id, String, nil?: true

#content ⇒ String?

The main body of the post in Markdown format. For example, 'Check out this update'. Hidden if the post is paywalled and the viewer has not purchased access.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


39
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 39

optional :content, String, nil?: true

#experience_id ⇒ String

The unique identifier of the experience to create this post in. For example, 'exp_xxxxx'. Pass 'public' along with company_id to automatically use the company's public forum.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 16

required :experience_id, String

#is_mention ⇒ Boolean?

Whether to send this post as a mention notification to all users in the experience who have mentions enabled.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 46

optional :is_mention, WhopSDK::Internal::Type::Boolean, nil?: true

#parent_id ⇒ String?

The unique identifier of the parent post to comment on. Omit this field to create a top-level post.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 53

optional :parent_id, String, nil?: true

#paywall_amount ⇒ Float?

The price to unlock this post in the specified paywall currency. For example, 5.00 for $5.00. When set, users must purchase access to view the post content.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


60
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 60

optional :paywall_amount, Float, nil?: true

#paywall_currency ⇒ Symbol, ...

The available currencies on the platform

Parameters:

  • value (WhopSDK::Models::currency, nil)

Returns:



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

optional :paywall_currency, enum: -> { WhopSDK::Currency }, nil?: true

#pinned ⇒ Boolean?

Whether this post should be pinned to the top of the forum.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


72
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 72

optional :pinned, WhopSDK::Internal::Type::Boolean, nil?: true

#poll ⇒ WhopSDK::Models::ForumPostCreateParams::Poll?

A poll to attach to this post, allowing members to vote on options.

Parameters:

  • value (WhopSDK::ForumPostCreateParams::Poll, nil)

Returns:



78
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 78

optional :poll, -> { WhopSDK::ForumPostCreateParams::Poll }, nil?: true

#rich_content ⇒ String?

The rich content of the post in Tiptap JSON format. When provided, takes priority over the markdown content field for rendering.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


85
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 85

optional :rich_content, String, nil?: true

#title ⇒ String?

The title of the post, displayed prominently at the top. Required for paywalled posts as it remains visible to non-purchasers.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


92
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 92

optional :title, String, nil?: true

#visibility ⇒ Symbol, ...

The visibility types for forum posts

Parameters:

  • value (WhopSDK::Models::forum_post_visibility_type, nil)

Returns:



98
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 98

optional :visibility, enum: -> { WhopSDK::ForumPostVisibilityType }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/whop_sdk/models/forum_post_create_params.rbs', line 68

def to_hash: -> {