Class: WhopSDK::Models::ReviewRetrieveResponse::Attachment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/review_retrieve_response.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(id: , attachments: , company: , created_at: , description: , joined_at: , paid_for_product: , product: , published_at: , stars: , status: , title: , updated_at: , user: ) ⇒ Object

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

An object representing a user review of a company.

Parameters:

  • id (String) (defaults to: ) —

    The internal ID of the review.

  • attachments (Array<WhopSDK::Models::ReviewRetrieveResponse::Attachment>) (defaults to: ) —

    The attachments attached to the review.

  • company (WhopSDK::Models::ReviewRetrieveResponse::Company) (defaults to: ) —

    The company the review is for.

  • created_at (Time) (defaults to: ) —

    The timestamp of when the review was created.

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

    The description of the review.

  • joined_at (Time, nil) (defaults to: ) —

    The timestamp of when the user joined the product.

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

    Whether or not the user paid for the product. If null, the payment status is unk

  • product (WhopSDK::Models::ReviewRetrieveResponse::Product) (defaults to: ) —

    The product the review is for.

  • published_at (Time, nil) (defaults to: ) —

    The timestamp of when the review was published.

  • stars (Integer) (defaults to: ) —

    The number of stars the user gave the product.

  • status (Symbol, WhopSDK::Models::ReviewStatus) (defaults to: ) —

    The status of the review.

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

    The title of the review.

  • updated_at (Time) (defaults to: ) —

    The timestamp of when the review was last updated.

  • user (WhopSDK::Models::ReviewRetrieveResponse::User) (defaults to: ) —

    The user account that performed the action.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/whop_sdk/models/review_retrieve_response.rb', line 127

class Attachment < WhopSDK::Internal::Type::BaseModel
  # @!attribute id
  #   The ID of the attachment
  #
  #   @return [String]
  required :id, String

  # @!attribute content_type
  #   The attachment's content type (e.g., image/jpg, video/mp4)
  #
  #   @return [String, nil]
  required :content_type, String, nil?: true

  # @!attribute filename
  #   The name of the file
  #
  #   @return [String, nil]
  required :filename, String, nil?: true

  # @!attribute url
  #   This is the URL you use to render optimized attachments on the client. This
  #   should be used for apps.
  #
  #   @return [String, nil]
  required :url, String, nil?: true

  # @!method initialize(id:, content_type:, filename:, url:)
  #   Some parameter documentations has been truncated, see
  #   {WhopSDK::Models::ReviewRetrieveResponse::Attachment} for more details.
  #
  #   Represents an image attachment
  #
  #   @param id [String] The ID of the attachment
  #
  #   @param content_type [String, nil] The attachment's content type (e.g., image/jpg, video/mp4)
  #
  #   @param filename [String, nil] The name of the file
  #
  #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
end

Instance Attribute Details

#content_type ⇒ String?

The attachment’s content type (e.g., image/jpg, video/mp4)

Returns:

  • (String, nil) 


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

required :content_type, String, nil?: true

#filename ⇒ String?

The name of the file

Returns:

  • (String, nil) 


144
 
# File 'lib/whop_sdk/models/review_retrieve_response.rb', line 144

required :filename, String, nil?: true

#id ⇒ String

The ID of the attachment

Returns:

  • (String) 


132
 
# File 'lib/whop_sdk/models/review_retrieve_response.rb', line 132

required :id, String

#url ⇒ String?

This is the URL you use to render optimized attachments on the client. This should be used for apps.

Returns:

  • (String, nil) 


151
 
# File 'lib/whop_sdk/models/review_retrieve_response.rb', line 151

required :url, String, nil?: true