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.

A user-submitted review of a company, including a star rating and optional text feedback.

Parameters:

  • id (String) —

    The unique identifier for the review.

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

    A list of files and media attached to the review.

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

    The company that this review was written for.

  • created_at (Time) —

    The datetime the review was created.

  • description (String, nil) —

    The body text of the review containing the user’s detailed feedback. Returns an

  • joined_at (Time, nil) —

    The timestamp of when the reviewer first joined the product. Null if unknown.

  • paid_for_product (Boolean, nil) —

    Whether the reviewer paid for the product. Null if the payment status is unknown

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

    The product that this review was written for.

  • published_at (Time, nil) —

    The timestamp of when the review was published. Null if the review has not been

  • stars (Integer) —

    The star rating given by the reviewer, from 1 to 5.

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

    The current moderation status of the review.

  • title (String, nil) —

    A short summary title for the review. Null if the reviewer did not provide one.

  • updated_at (Time) —

    The datetime the review was last updated.

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

    The user account of the person who wrote this review.



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
167
168
169
170
171
172
173
 
# File 'lib/whop_sdk/models/review_retrieve_response.rb', line 130

class Attachment < WhopSDK::Internal::Type::BaseModel
  # @!attribute id
  #   Represents a unique identifier that is Base64 obfuscated. It is often used to
  #   refetch an object or as key for a cache. The ID type appears in a JSON response
  #   as a String; however, it is not intended to be human-readable. When expected as
  #   an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
  #   input value will be accepted as an ID.
  #
  #   @return [String]
  required :id, String

  # @!attribute content_type
  #   The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
  #
  #   @return [String, nil]
  required :content_type, String, nil?: true

  # @!attribute filename
  #   The original filename of the uploaded attachment, including its file extension.
  #
  #   @return [String, nil]
  required :filename, String, nil?: true

  # @!attribute url
  #   A pre-optimized URL for rendering this attachment on the client. This should be
  #   used for displaying attachments in 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] Represents a unique identifier that is Base64 obfuscated. It is often used to re
  #
  #   @param content_type [String, nil] The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
  #
  #   @param filename [String, nil] The original filename of the uploaded attachment, including its file extension.
  #
  #   @param url [String, nil] A pre-optimized URL for rendering this attachment on the client. This should be
end

Instance Attribute Details

#content_type ⇒ String?

The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).

Returns:

  • (String, nil) 


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

required :content_type, String, nil?: true

#filename ⇒ String?

The original filename of the uploaded attachment, including its file extension.

Returns:

  • (String, nil) 


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

required :filename, String, nil?: true

#id ⇒ String

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as ‘“VXNlci0xMA==”`) or integer (such as `4`) input value will be accepted as an ID.

Returns:

  • (String) 


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

required :id, String

#url ⇒ String?

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.

Returns:

  • (String, nil) 


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

required :url, String, nil?: true