whop_sdk 0.0.2

data/lib/whop_sdk/models/entry_list_response.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#list
+    class EntryListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the entry.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the entry was created.
+      #
+      #   @return [Time, nil]
+      required :created_at, Time, nil?: true
+
+      # @!attribute plan
+      #   The waitlist plan the entry if for.
+      #
+      #   @return [WhopSDK::Models::EntryListResponse::Plan, nil]
+      required :plan, -> { WhopSDK::Models::EntryListResponse::Plan }, nil?: true
+
+      # @!attribute product
+      #   The access pass tied to this entry, if there is one.
+      #
+      #   @return [WhopSDK::Models::EntryListResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::EntryListResponse::Product }, nil?: true
+
+      # @!attribute status
+      #   The status of the entry.
+      #
+      #   @return [Symbol, WhopSDK::Models::EntryStatus]
+      required :status, enum: -> { WhopSDK::EntryStatus }
+
+      # @!attribute user
+      #   The user who created the entry.
+      #
+      #   @return [WhopSDK::Models::EntryListResponse::User]
+      required :user, -> { WhopSDK::Models::EntryListResponse::User }
+
+      # @!method initialize(id:, created_at:, plan:, product:, status:, user:)
+      #   An object representing an entry in a waitlist.
+      #
+      #   @param id [String] The internal ID of the entry.
+      #
+      #   @param created_at [Time, nil] When the entry was created.
+      #
+      #   @param plan [WhopSDK::Models::EntryListResponse::Plan, nil] The waitlist plan the entry if for.
+      #
+      #   @param product [WhopSDK::Models::EntryListResponse::Product, nil] The access pass tied to this entry, if there is one.
+      #
+      #   @param status [Symbol, WhopSDK::Models::EntryStatus] The status of the entry.
+      #
+      #   @param user [WhopSDK::Models::EntryListResponse::User] The user who created the entry.
+
+      # @see WhopSDK::Models::EntryListResponse#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The waitlist plan the entry if for.
+        #
+        #   @param id [String] The internal ID of the plan.
+      end
+
+      # @see WhopSDK::Models::EntryListResponse#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The access pass tied to this entry, if there is one.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+
+      # @see WhopSDK::Models::EntryListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!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:, email:, name:, username:)
+        #   The user who created the entry.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email 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
+    end
+  end
+end

data/lib/whop_sdk/models/entry_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#retrieve
+    class EntryRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/entry_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The status of an entry to a waitlist.
+    module EntryStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      DRAFTED = :drafted
+      PENDING = :pending
+      APPROVED = :approved
+      DENIED = :denied
+      ANY = :any
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/experience.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Experience < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique ID representing this experience
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute app
+      #   The experience interface for this experience.
+      #
+      #   @return [WhopSDK::Models::Experience::App]
+      required :app, -> { WhopSDK::Experience::App }
+
+      # @!attribute company
+      #   The company that owns this experience.
+      #
+      #   @return [WhopSDK::Models::Experience::Company]
+      required :company, -> { WhopSDK::Experience::Company }
+
+      # @!attribute created_at
+      #   The timestamp of when this experience was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute image
+      #   The logo for the experience.
+      #
+      #   @return [WhopSDK::Models::Experience::Image, nil]
+      required :image, -> { WhopSDK::Experience::Image }, nil?: true
+
+      # @!attribute name
+      #   The written name of the description.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute order
+      #   The order of the experience in the section
+      #
+      #   @return [String, nil]
+      required :order, String, nil?: true
+
+      # @!attribute products
+      #   The access passes that are associated with this experience. This should not be
+      #   used unless you are trying to list all access passes the experience has, for
+      #   some reason. You probably don't want to use this though and should be using
+      #   accessPass.
+      #
+      #   @return [Array<WhopSDK::Models::Experience::Product>]
+      required :products, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Experience::Product] }
+
+      # @!method initialize(id:, app:, company:, created_at:, image:, name:, order:, products:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::Experience} for more details.
+      #
+      #   An object representing an experience belonging to a company.
+      #
+      #   @param id [String] The unique ID representing this experience
+      #
+      #   @param app [WhopSDK::Models::Experience::App] The experience interface for this experience.
+      #
+      #   @param company [WhopSDK::Models::Experience::Company] The company that owns this experience.
+      #
+      #   @param created_at [Time] The timestamp of when this experience was created.
+      #
+      #   @param image [WhopSDK::Models::Experience::Image, nil] The logo for the experience.
+      #
+      #   @param name [String] The written name of the description.
+      #
+      #   @param order [String, nil] The order of the experience in the section
+      #
+      #   @param products [Array<WhopSDK::Models::Experience::Product>] The access passes that are associated with this experience. This should not be u
+
+      # @see WhopSDK::Models::Experience#app
+      class App < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the app
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute icon
+        #   The icon for the app. This icon is shown on discovery, on the product page, on
+        #   checkout, and as a default icon for the experiences.
+        #
+        #   @return [WhopSDK::Models::Experience::App::Icon, nil]
+        required :icon, -> { WhopSDK::Experience::App::Icon }, nil?: true
+
+        # @!attribute name
+        #   The name of the app
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, icon:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Experience::App} for more details.
+        #
+        #   The experience interface for this experience.
+        #
+        #   @param id [String] The ID of the app
+        #
+        #   @param icon [WhopSDK::Models::Experience::App::Icon, nil] The icon for the app. This icon is shown on discovery, on the product page, on c
+        #
+        #   @param name [String] The name of the app
+
+        # @see WhopSDK::Models::Experience::App#icon
+        class Icon < WhopSDK::Internal::Type::BaseModel
+          # @!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(url:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::Experience::App::Icon} for more details.
+          #
+          #   The icon for the app. This icon is shown on discovery, on the product page, on
+          #   checkout, and as a default icon for the experiences.
+          #
+          #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+        end
+      end
+
+      # @see WhopSDK::Models::Experience#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:)
+        #   The company that owns this experience.
+        #
+        #   @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::Experience#image
+      class Image < WhopSDK::Internal::Type::BaseModel
+        # @!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(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Experience::Image} for more details.
+        #
+        #   The logo for the experience.
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!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
+
+        # @!method initialize(id:, route:, title:)
+        #   An object representing a (sanitized) access pass.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param route [String] The route of the product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/experience_attach_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#attach
+    class ExperienceAttachParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   The ID of the Access Pass to add the Experience to.
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!method initialize(product_id:, request_options: {})
+      #   @param product_id [String] The ID of the Access Pass to add the Experience to.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/experience_create_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#create
+    class ExperienceCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute app_id
+      #   The ID of the app to create the experience for
+      #
+      #   @return [String]
+      required :app_id, String
+
+      # @!attribute company_id
+      #   The ID of the company to create the experience for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute name
+      #   The name of the experience
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute section_id
+      #   The ID of the section to create the experience in
+      #
+      #   @return [String, nil]
+      optional :section_id, String, nil?: true
+
+      # @!method initialize(app_id:, company_id:, name: nil, section_id: nil, request_options: {})
+      #   @param app_id [String] The ID of the app to create the experience for
+      #
+      #   @param company_id [String] The ID of the company to create the experience for
+      #
+      #   @param name [String, nil] The name of the experience
+      #
+      #   @param section_id [String, nil] The ID of the section to create the experience in
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/experience_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#delete
+    class ExperienceDeleteParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/experience_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    ExperienceDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/experience_detach_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#detach
+    class ExperienceDetachParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   The ID of the Access Pass to add the Experience to.
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!method initialize(product_id:, request_options: {})
+      #   @param product_id [String] The ID of the Access Pass to add the Experience to.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/experience_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#list
+    class ExperienceListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to filter experiences by
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute app_id
+      #   The ID of the app to filter experiences by
+      #
+      #   @return [String, nil]
+      optional :app_id, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute product_id
+      #   The ID of the product to filter experiences by
+      #
+      #   @return [String, nil]
+      optional :product_id, String, nil?: true
+
+      # @!method initialize(company_id:, after: nil, app_id: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to filter experiences by
+      #
+      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @param app_id [String, nil] The ID of the app to filter experiences by
+      #
+      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param product_id [String, nil] The ID of the product to filter experiences by
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end