Class: WhopSDK::Models::ProductCreateParams::BannerImage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/product_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(company_id: , title: , access_pass_type: nil, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_highlights: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil, request_options: {}) ⇒ Object

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

betwee

Parameters:

  • company_id (String) (defaults to: ) —

    The ID of the company to create the product for.

  • title (String) (defaults to: ) —

    The title of the product.

  • access_pass_type (Symbol, WhopSDK::Models::AccessPassType, nil) (defaults to: nil) —

    The different types an access pass can be.

  • banner_image (WhopSDK::Models::ProductCreateParams::BannerImage, nil) (defaults to: nil) —

    A banner image for the product in png, jpeg format

  • business_type (Symbol, WhopSDK::Models::BusinessTypes, nil) (defaults to: nil) —

    The different business types a company can be.

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

    Whether or not to collect shipping information at checkout from the customer.

  • custom_cta (Symbol, WhopSDK::Models::CustomCta, nil) (defaults to: nil) —

    The different types of custom CTAs that can be selected.

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

    The custom call to action URL for the product.

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

    The custom statement descriptor for the product i.e. WHOP*SPORTS, must be

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

    A written description of the product.

  • experience_ids (Array<String>, nil) (defaults to: nil) —

    An array of experience IDs that this pass has

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

    The percentage of the revenue that goes to the global affiliate program.

  • global_affiliate_status (Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil) (defaults to: nil) —

    The different statuses of the global affiliate program for an access pass.

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

    The headline of the product.

  • industry_type (Symbol, WhopSDK::Models::IndustryTypes, nil) (defaults to: nil) —

    The different industry types a company can be in.

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

    The percentage of the revenue that goes to the member affiliate program.

  • member_affiliate_status (Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil) (defaults to: nil) —

    The different statuses of the global affiliate program for an access pass.

  • plan_options (WhopSDK::Models::ProductCreateParams::PlanOptions, nil) (defaults to: nil) —

    The details to assign an autogenerated plan.

  • product_highlights (Array<WhopSDK::Models::ProductCreateParams::ProductHighlight>, nil) (defaults to: nil) —

    The product highlights for the product.

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

    The ID of the product tax code to apply to this product.

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

    The URL to redirect the customer to after a purchase.

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

    The route of the product.

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

    Visibility of a resource

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


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/whop_sdk/models/product_create_params.rb', line 205

class BannerImage < WhopSDK::Internal::Type::BaseModel
  # @!attribute id
  #   The ID of an existing attachment object. Use this when updating a resource and
  #   keeping a subset of the attachments. Don't use this unless you know what you're
  #   doing.
  #
  #   @return [String, nil]
  optional :id, String, nil?: true

  # @!attribute direct_upload_id
  #   This ID should be used the first time you upload an attachment. It is the ID of
  #   the direct upload that was created when uploading the file to S3 via the
  #   mediaDirectUpload mutation.
  #
  #   @return [String, nil]
  optional :direct_upload_id, String, nil?: true

  # @!method initialize(id: nil, direct_upload_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {WhopSDK::Models::ProductCreateParams::BannerImage} for more details.
  #
  #   A banner image for the product in png, jpeg format
  #
  #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
  #
  #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
end

Instance Attribute Details

#direct_upload_id ⇒ String?

This ID should be used the first time you upload an attachment. It is the ID of the direct upload that was created when uploading the file to S3 via the mediaDirectUpload mutation.

Returns:

  • (String, nil) 


220
 
# File 'lib/whop_sdk/models/product_create_params.rb', line 220

optional :direct_upload_id, String, nil?: true

#id ⇒ String?

The ID of an existing attachment object. Use this when updating a resource and keeping a subset of the attachments. Don’t use this unless you know what you’re doing.

Returns:

  • (String, nil) 


212
 
# File 'lib/whop_sdk/models/product_create_params.rb', line 212

optional :id, String, nil?: true