Class: WhopSDK::Models::ForumPostCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::ForumPostCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/forum_post_create_params.rb

Overview

See Also:

• Resources::ForumPosts#create

Defined Under Namespace

Classes: Attachment, Poll

Instance Attribute Summary

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

  The attachments for this post.

• #content ⇒ String^?

  This is the main body of the post in Markdown format.

• #experience_id ⇒ String

  The experience to create this post in.

• #is_mention ⇒ Boolean^?

  This is used to determine if the post should be sent as a ‘mention’ notification to all of the users who are in the experience.

• #parent_id ⇒ String^?

  The ID of the parent post.

• #paywall_amount ⇒ Float^?

  The amount to paywall this post by.

• #paywall_currency ⇒ Symbol, ...

  The available currencies on the platform.

• #pinned ⇒ Boolean^?

  Whether the post should be pinned.

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

  The poll for this post.

• #title ⇒ String^?

  The title of the post.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id: nil, direct_upload_id: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Attachment for more details.

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: nil, direct_upload_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Attachment for more details.

Input for an attachment

Parameters:

• id (String, nil) (defaults to: nil) —

  The ID of an existing attachment object. Use this when updating a resource and k

• direct_upload_id (String, nil) (defaults to: nil) —

  This ID should be used the first time you upload an attachment. It is the ID of

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

Instance Attribute Details

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

The attachments for this post

Returns:

• (Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil)

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

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

#content ⇒ String^?

This is the main body of the post in Markdown format. Hidden if paywalled and user hasn’t purchased access to it.

Returns:

• (String, nil)

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

optional :content, String, nil?: true

#experience_id ⇒ String

The experience to create this post in

Returns:

• (String)

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

required :experience_id, String

#is_mention ⇒ Boolean^?

This is used to determine if the post should be sent as a ‘mention’ notification to all of the users who are in the experience. This means that anyone with ‘mentions’ enabled will receive a notification about this post.

Returns:

• (Boolean, nil)

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

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

#parent_id ⇒ String^?

The ID of the parent post. Set it to the ID of the post you want to comment on or don’t include it if its a top level post.

Returns:

• (String, nil)

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

optional :parent_id, String, nil?: true

#paywall_amount ⇒ Float^?

The amount to paywall this post by. A paywalled post requires the user to purchase it in order to view its content.

Returns:

• (Float, nil)

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

optional :paywall_amount, Float, nil?: true

#paywall_currency ⇒ Symbol, ...

The available currencies on the platform

Returns:

• (Symbol, WhopSDK::Models::Currency, nil)

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

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

#pinned ⇒ Boolean^?

Whether the post should be pinned

Returns:

• (Boolean, nil)

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

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

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

The poll for this post

Returns:

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

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

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

#title ⇒ String^?

The title of the post. Only visible if paywalled.

Returns:

• (String, nil)

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

optional :title, String, nil?: true