Class: WhopSDK::Models::ForumPostCreateParams::Attachment

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

Instance Attribute 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(experience_id:, attachments: nil, company_id: nil, content: nil, is_mention: nil, parent_id: nil, paywall_amount: nil, paywall_currency: nil, pinned: nil, poll: nil, rich_content: nil, title: nil, visibility: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::ForumPostCreateParams for more details.

**upd

Parameters:

  • experience_id (String) —

    The unique identifier of the experience to create this post in. For example, ‘ex

  • attachments (Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil) (defaults to: nil) —

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

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

    The unique identifier of the company whose public forum to post in. Required whe

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

    The main body of the post in Markdown format. For example, ‘Check out this

  • is_mention (Boolean, nil) (defaults to: nil) —

    Whether to send this post as a mention notification to all users in the experien

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

    The unique identifier of the parent post to comment on. Omit this field to creat

  • paywall_amount (Float, nil) (defaults to: nil) —

    The price to unlock this post in the specified paywall currency. For example, 5.

  • paywall_currency (Symbol, WhopSDK::Models::Currency, nil) (defaults to: nil) —

    The available currencies on the platform

  • pinned (Boolean, nil) (defaults to: nil) —

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

  • poll (WhopSDK::Models::ForumPostCreateParams::Poll, nil) (defaults to: nil) —

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

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

    The rich content of the post in Tiptap JSON format. When provided, takes priorit

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

    The title of the post, displayed prominently at the top. Required for paywalled

  • visibility (Symbol, WhopSDK::Models::ForumPostVisibilityType, nil) (defaults to: nil) —

    The visibility types for forum posts

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/whop_sdk/models/forum_post_create_params.rb', line 133

class Attachment < WhopSDK::Internal::Type::BaseModel
  # @!attribute id
  #   The ID of an existing file object.
  #
  #   @return [String]
  required :id, String

  # @!method initialize(id:)
  #   Input for an attachment
  #
  #   @param id [String] The ID of an existing file object.
end

Instance Attribute Details

#id ⇒ String

The ID of an existing file object.

Returns:

  • (String) 


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

required :id, String