whop_sdk 0.0.2

data/lib/whop_sdk/models/plan_update_params.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#update
+    class PlanUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute billing_period
+      #   The interval at which the plan charges (renewal plans).
+      #
+      #   @return [Integer, nil]
+      optional :billing_period, Integer, nil?: true
+
+      # @!attribute currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute custom_fields
+      #   An array of custom field objects.
+      #
+      #   @return [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil]
+      optional :custom_fields,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::PlanUpdateParams::CustomField] },
+               nil?: true
+
+      # @!attribute description
+      #   The description of the plan.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute expiration_days
+      #   The interval at which the plan charges (expiration plans).
+      #
+      #   @return [Integer, nil]
+      optional :expiration_days, Integer, nil?: true
+
+      # @!attribute image
+      #   An image for the plan. This will be visible on the product page to customers.
+      #
+      #   @return [WhopSDK::Models::PlanUpdateParams::Image, nil]
+      optional :image, -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
+
+      # @!attribute initial_price
+      #   An additional amount charged upon first purchase.
+      #
+      #   @return [Float, nil]
+      optional :initial_price, Float, nil?: true
+
+      # @!attribute internal_notes
+      #   A personal description or notes section for the business.
+      #
+      #   @return [String, nil]
+      optional :internal_notes, String, nil?: true
+
+      # @!attribute offer_cancel_discount
+      #   Whether or not to offer a discount to cancel a subscription.
+      #
+      #   @return [Boolean, nil]
+      optional :offer_cancel_discount, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute override_tax_type
+      #   Whether or not the tax is included in a plan's price (or if it hasn't been set
+      #   up)
+      #
+      #   @return [Symbol, WhopSDK::Models::TaxType, nil]
+      optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
+
+      # @!attribute renewal_price
+      #   The amount the customer is charged every billing period.
+      #
+      #   @return [Float, nil]
+      optional :renewal_price, Float, nil?: true
+
+      # @!attribute title
+      #   The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!attribute trial_period_days
+      #   The number of free trial days added before a renewal plan.
+      #
+      #   @return [Integer, nil]
+      optional :trial_period_days, Integer, nil?: true
+
+      # @!attribute visibility
+      #   Visibility of a resource
+      #
+      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
+      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+
+      # @!method initialize(billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PlanUpdateParams} for more details.
+      #
+      #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      #   @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field objects.
+      #
+      #   @param description [String, nil] The description of the plan.
+      #
+      #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+      #
+      #   @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
+      #
+      #   @param initial_price [Float, nil] An additional amount charged upon first purchase.
+      #
+      #   @param internal_notes [String, nil] A personal description or notes section for the business.
+      #
+      #   @param offer_cancel_discount [Boolean, nil] Whether or not to offer a discount to cancel a subscription.
+      #
+      #   @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      #
+      #   @param renewal_price [Float, nil] The amount the customer is charged every billing period.
+      #
+      #   @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        # @!attribute field_type
+        #   The type of the custom field.
+        #
+        #   @return [Symbol, :text]
+        required :field_type, const: :text
+
+        # @!attribute name
+        #   The name of the custom field.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute id
+        #   The ID of the custom field (if being updated)
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute order
+        #   The order of the field.
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer, nil?: true
+
+        # @!attribute placeholder
+        #   The placeholder value of the field.
+        #
+        #   @return [String, nil]
+        optional :placeholder, String, nil?: true
+
+        # @!attribute required
+        #   Whether or not the field is required.
+        #
+        #   @return [Boolean, nil]
+        optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
+        #   @param name [String] The name of the custom field.
+        #
+        #   @param id [String, nil] The ID of the custom field (if being updated)
+        #
+        #   @param order [Integer, nil] The order of the field.
+        #
+        #   @param placeholder [String, nil] The placeholder value of the field.
+        #
+        #   @param required [Boolean, nil] Whether or not the field is required.
+        #
+        #   @param field_type [Symbol, :text] The type of the custom field.
+      end
+
+      class Image < 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::PlanUpdateParams::Image} for more details.
+        #
+        #   An image for the plan. This will be visible on the product page to customers.
+        #
+        #   @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
+    end
+  end
+end

data/lib/whop_sdk/models/product.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Product < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the public product.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute business_type
+      #   The different business types a company can be.
+      #
+      #   @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
+      required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
+
+      # @!attribute company
+      #   A short type of the company that this product belongs to.
+      #
+      #   @return [WhopSDK::Models::Product::Company]
+      required :company, -> { WhopSDK::Product::Company }
+
+      # @!attribute created_at
+      #   When the product was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute custom_cta
+      #   The custom call to action for the product.
+      #
+      #   @return [Symbol, WhopSDK::Models::CustomCta]
+      required :custom_cta, enum: -> { WhopSDK::CustomCta }
+
+      # @!attribute custom_cta_url
+      #   The custom call to action URL for the product, if any.
+      #
+      #   @return [String, nil]
+      required :custom_cta_url, String, nil?: true
+
+      # @!attribute custom_statement_descriptor
+      #   The custom statement descriptor for the product.
+      #
+      #   @return [String, nil]
+      required :custom_statement_descriptor, String, nil?: true
+
+      # @!attribute description
+      #   A short description of what the company offers or does.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute global_affiliate_percentage
+      #   The percentage of a transaction a user is eligible to earn from the whop
+      #   marketplace global affiliate program.
+      #
+      #   @return [Float, nil]
+      required :global_affiliate_percentage, Float, nil?: true
+
+      # @!attribute global_affiliate_status
+      #   The status of the global affiliate program for this product.
+      #
+      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus]
+      required :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }
+
+      # @!attribute headline
+      #   The headline of the product.
+      #
+      #   @return [String, nil]
+      required :headline, String, nil?: true
+
+      # @!attribute industry_type
+      #   The different industry types a company can be in.
+      #
+      #   @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
+      required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
+
+      # @!attribute member_affiliate_percentage
+      #   The percentage of a transaction a user is eligible to earn from the whop
+      #   marketplace member affiliate program.
+      #
+      #   @return [Float, nil]
+      required :member_affiliate_percentage, Float, nil?: true
+
+      # @!attribute member_affiliate_status
+      #   The status of the member affiliate program for this product.
+      #
+      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus]
+      required :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }
+
+      # @!attribute member_count
+      #   The number of active users for this product.
+      #
+      #   @return [Integer]
+      required :member_count, Integer
+
+      # @!attribute owner_user
+      #   The user that owns the product (company owner).
+      #
+      #   @return [WhopSDK::Models::Product::OwnerUser]
+      required :owner_user, -> { WhopSDK::Product::OwnerUser }
+
+      # @!attribute product_tax_code
+      #   The product tax code for the product, if any.
+      #
+      #   @return [WhopSDK::Models::Product::ProductTaxCode, nil]
+      required :product_tax_code, -> { WhopSDK::Product::ProductTaxCode }, nil?: true
+
+      # @!attribute published_reviews_count
+      #   The number of reviews that have been published for the product.
+      #
+      #   @return [Integer]
+      required :published_reviews_count, Integer
+
+      # @!attribute route
+      #   The route of the product.
+      #
+      #   @return [String]
+      required :route, String
+
+      # @!attribute title
+      #   The title of the product. Use for Whop 4.0.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute updated_at
+      #   When the product was updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute verified
+      #   Whether this product is Whop verified.
+      #
+      #   @return [Boolean]
+      required :verified, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute visibility
+      #   This product will/will not be displayed publicly.
+      #
+      #   @return [Symbol, WhopSDK::Models::Visibility]
+      required :visibility, enum: -> { WhopSDK::Visibility }
+
+      # @!method initialize(id:, business_type:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, global_affiliate_percentage:, global_affiliate_status:, headline:, industry_type:, member_affiliate_percentage:, member_affiliate_status:, member_count:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
+      #   Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
+      #   for more details.
+      #
+      #   An object representing a (sanitized) access pass.
+      #
+      #   @param id [String] The internal ID of the public product.
+      #
+      #   @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
+      #
+      #   @param company [WhopSDK::Models::Product::Company] A short type of the company that this product belongs to.
+      #
+      #   @param created_at [Time] When the product was created.
+      #
+      #   @param custom_cta [Symbol, WhopSDK::Models::CustomCta] The custom call to action for the product.
+      #
+      #   @param custom_cta_url [String, nil] The custom call to action URL for the product, if any.
+      #
+      #   @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product.
+      #
+      #   @param description [String, nil] A short description of what the company offers or does.
+      #
+      #   @param global_affiliate_percentage [Float, nil] The percentage of a transaction a user is eligible to earn from the whop marketp
+      #
+      #   @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus] The status of the global affiliate program for this product.
+      #
+      #   @param headline [String, nil] The headline of the product.
+      #
+      #   @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
+      #
+      #   @param member_affiliate_percentage [Float, nil] The percentage of a transaction a user is eligible to earn from the whop marketp
+      #
+      #   @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus] The status of the member affiliate program for this product.
+      #
+      #   @param member_count [Integer] The number of active users for this product.
+      #
+      #   @param owner_user [WhopSDK::Models::Product::OwnerUser] The user that owns the product (company owner).
+      #
+      #   @param product_tax_code [WhopSDK::Models::Product::ProductTaxCode, nil] The product tax code for the product, if any.
+      #
+      #   @param published_reviews_count [Integer] The number of reviews that have been published for the product.
+      #
+      #   @param route [String] The route of the product.
+      #
+      #   @param title [String] The title of the product. Use for Whop 4.0.
+      #
+      #   @param updated_at [Time] When the product was updated.
+      #
+      #   @param verified [Boolean] Whether this product is Whop verified.
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::Visibility] This product will/will not be displayed publicly.
+
+      # @see WhopSDK::Models::Product#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID (tag) of the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute route
+        #   The slug/route of the company on the Whop site.
+        #
+        #   @return [String]
+        required :route, String
+
+        # @!attribute title
+        #   The title of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   A short type of the company that this product belongs to.
+        #
+        #   @param id [String] The ID (tag) of the company.
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The title of the company.
+      end
+
+      # @see WhopSDK::Models::Product#owner_user
+      class OwnerUser < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user that owns the product (company owner).
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+
+      # @see WhopSDK::Models::Product#product_tax_code
+      class ProductTaxCode < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the product tax code.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the product tax code.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute product_type
+        #   The type of product this tax code applies to.
+        #
+        #   @return [Symbol, WhopSDK::Models::Product::ProductTaxCode::ProductType]
+        required :product_type, enum: -> { WhopSDK::Product::ProductTaxCode::ProductType }
+
+        # @!method initialize(id:, name:, product_type:)
+        #   The product tax code for the product, if any.
+        #
+        #   @param id [String] The internal ID of the product tax code.
+        #
+        #   @param name [String] The name of the product tax code.
+        #
+        #   @param product_type [Symbol, WhopSDK::Models::Product::ProductTaxCode::ProductType] The type of product this tax code applies to.
+
+        # The type of product this tax code applies to.
+        #
+        # @see WhopSDK::Models::Product::ProductTaxCode#product_type
+        module ProductType
+          extend WhopSDK::Internal::Type::Enum
+
+          PHYSICAL = :physical
+          DIGITAL = :digital
+          SERVICES = :services
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end