whop_sdk 0.0.2

data/lib/whop_sdk/models/app_view_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different types of an app view
+    module AppViewType
+      extend WhopSDK::Internal::Type::Enum
+
+      HUB = :hub
+      DISCOVER = :discover
+      DASH = :dash
+      DASHBOARD = :dashboard
+      ANALYTICS = :analytics
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/authorized_user_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AuthorizedUsers#list
+    class AuthorizedUserListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list authorized users for
+      #
+      #   @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 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 role
+      #   Possible roles an authorized user can have
+      #
+      #   @return [Symbol, WhopSDK::Models::AuthorizedUserRoles, nil]
+      optional :role, enum: -> { WhopSDK::AuthorizedUserRoles }, nil?: true
+
+      # @!attribute user_id
+      #   Filter by the user ID to check if the user is an authorized user
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, first: nil, last: nil, role: nil, user_id: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to list authorized users for
+      #
+      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @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 role [Symbol, WhopSDK::Models::AuthorizedUserRoles, nil] Possible roles an authorized user can have
+      #
+      #   @param user_id [String, nil] Filter by the user ID to check if the user is an authorized user
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/authorized_user_list_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AuthorizedUsers#list
+    class AuthorizedUserListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID representing the authorized user object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute role
+      #   The role of the authorized user in the company.
+      #
+      #   @return [Symbol, WhopSDK::Models::AuthorizedUserRoles]
+      required :role, enum: -> { WhopSDK::AuthorizedUserRoles }
+
+      # @!attribute user
+      #   The user associated with the authorized user.
+      #
+      #   @return [WhopSDK::Models::AuthorizedUserListResponse::User]
+      required :user, -> { WhopSDK::Models::AuthorizedUserListResponse::User }
+
+      # @!method initialize(id:, role:, user:)
+      #   A user who has elevated security privileges for a company
+      #
+      #   @param id [String] A unique ID representing the authorized user object.
+      #
+      #   @param role [Symbol, WhopSDK::Models::AuthorizedUserRoles] The role of the authorized user in the company.
+      #
+      #   @param user [WhopSDK::Models::AuthorizedUserListResponse::User] The user associated with the authorized user.
+
+      # @see WhopSDK::Models::AuthorizedUserListResponse#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 associated with the authorized user.
+        #
+        #   @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/authorized_user_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AuthorizedUsers#retrieve
+    class AuthorizedUserRetrieveParams < 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/authorized_user_retrieve_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AuthorizedUsers#retrieve
+    class AuthorizedUserRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID representing the authorized user object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute role
+      #   The role of the authorized user in the company.
+      #
+      #   @return [Symbol, WhopSDK::Models::AuthorizedUserRoles]
+      required :role, enum: -> { WhopSDK::AuthorizedUserRoles }
+
+      # @!attribute user
+      #   The user associated with the authorized user.
+      #
+      #   @return [WhopSDK::Models::AuthorizedUserRetrieveResponse::User]
+      required :user, -> { WhopSDK::Models::AuthorizedUserRetrieveResponse::User }
+
+      # @!method initialize(id:, role:, user:)
+      #   A user who has elevated security privileges for a company
+      #
+      #   @param id [String] A unique ID representing the authorized user object.
+      #
+      #   @param role [Symbol, WhopSDK::Models::AuthorizedUserRoles] The role of the authorized user in the company.
+      #
+      #   @param user [WhopSDK::Models::AuthorizedUserRetrieveResponse::User] The user associated with the authorized user.
+
+      # @see WhopSDK::Models::AuthorizedUserRetrieveResponse#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 associated with the authorized user.
+        #
+        #   @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/authorized_user_roles.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # Possible roles an authorized user can have
+    module AuthorizedUserRoles
+      extend WhopSDK::Internal::Type::Enum
+
+      OWNER = :owner
+      ADMIN = :admin
+      SALES_MANAGER = :sales_manager
+      MODERATOR = :moderator
+      APP_MANAGER = :app_manager
+      SUPPORT = :support
+      MANAGER = :manager
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/business_types.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different business types a company can be.
+    module BusinessTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      EDUCATION_PROGRAM = :education_program
+      COACHING = :coaching
+      SOFTWARE = :software
+      PAID_GROUP = :paid_group
+      NEWSLETTER = :newsletter
+      AGENCY = :agency
+      PHYSICAL_PRODUCTS = :physical_products
+      BRICK_AND_MORTAR = :brick_and_mortar
+      EVENTS = :events
+      COACHING_AND_COURSES = :coaching_and_courses
+      OTHER = :other
+      SAAS = :saas
+      COURSE = :course
+      COMMUNITY = :community
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/chat_channel.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class ChatChannel < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute ban_media
+      #   Whether or not media is banned in this chat
+      #
+      #   @return [Boolean]
+      required :ban_media, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute ban_urls
+      #   Whether or not URLs are banned in this chat
+      #
+      #   @return [Boolean]
+      required :ban_urls, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute banned_words
+      #   List of banned words in this chat
+      #
+      #   @return [Array<String>]
+      required :banned_words, WhopSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute experience
+      #   The experience for this chat
+      #
+      #   @return [WhopSDK::Models::ChatChannel::Experience]
+      required :experience, -> { WhopSDK::ChatChannel::Experience }
+
+      # @!attribute user_posts_cooldown_seconds
+      #   The number of seconds a user needs to wait before posting again, if any
+      #
+      #   @return [Integer, nil]
+      required :user_posts_cooldown_seconds, Integer, nil?: true
+
+      # @!attribute who_can_post
+      #   Who can post on this chat
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPost]
+      required :who_can_post, enum: -> { WhopSDK::WhoCanPost }
+
+      # @!attribute who_can_react
+      #   Who can react on this chat
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanReact]
+      required :who_can_react, enum: -> { WhopSDK::WhoCanReact }
+
+      # @!method initialize(id:, ban_media:, ban_urls:, banned_words:, experience:, user_posts_cooldown_seconds:, who_can_post:, who_can_react:)
+      #   Represents a Chat feed
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param ban_media [Boolean] Whether or not media is banned in this chat
+      #
+      #   @param ban_urls [Boolean] Whether or not URLs are banned in this chat
+      #
+      #   @param banned_words [Array<String>] List of banned words in this chat
+      #
+      #   @param experience [WhopSDK::Models::ChatChannel::Experience] The experience for this chat
+      #
+      #   @param user_posts_cooldown_seconds [Integer, nil] The number of seconds a user needs to wait before posting again, if any
+      #
+      #   @param who_can_post [Symbol, WhopSDK::Models::WhoCanPost] Who can post on this chat
+      #
+      #   @param who_can_react [Symbol, WhopSDK::Models::WhoCanReact] Who can react on this chat
+
+      # @see WhopSDK::Models::ChatChannel#experience
+      class Experience < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID representing this experience
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The written name of the description.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   The experience for this chat
+        #
+        #   @param id [String] The unique ID representing this experience
+        #
+        #   @param name [String] The written name of the description.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/chat_channel_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ChatChannels#list
+    class ChatChannelListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list chat channels for
+      #
+      #   @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 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
+      #   If provided, only chat channels connected to this product are returned
+      #
+      #   @return [String, nil]
+      optional :product_id, String, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to list chat channels for
+      #
+      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @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] If provided, only chat channels connected to this product are returned
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/chat_channel_list_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ChatChannels#list
+    class ChatChannelListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute ban_media
+      #   Whether or not media is banned in this chat
+      #
+      #   @return [Boolean]
+      required :ban_media, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute ban_urls
+      #   Whether or not URLs are banned in this chat
+      #
+      #   @return [Boolean]
+      required :ban_urls, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute banned_words
+      #   List of banned words in this chat
+      #
+      #   @return [Array<String>]
+      required :banned_words, WhopSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute experience
+      #   The experience for this chat
+      #
+      #   @return [WhopSDK::Models::ChatChannelListResponse::Experience]
+      required :experience, -> { WhopSDK::Models::ChatChannelListResponse::Experience }
+
+      # @!attribute user_posts_cooldown_seconds
+      #   The number of seconds a user needs to wait before posting again, if any
+      #
+      #   @return [Integer, nil]
+      required :user_posts_cooldown_seconds, Integer, nil?: true
+
+      # @!attribute who_can_post
+      #   Who can post on this chat
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPost]
+      required :who_can_post, enum: -> { WhopSDK::WhoCanPost }
+
+      # @!attribute who_can_react
+      #   Who can react on this chat
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanReact]
+      required :who_can_react, enum: -> { WhopSDK::WhoCanReact }
+
+      # @!method initialize(id:, ban_media:, ban_urls:, banned_words:, experience:, user_posts_cooldown_seconds:, who_can_post:, who_can_react:)
+      #   Represents a Chat feed
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param ban_media [Boolean] Whether or not media is banned in this chat
+      #
+      #   @param ban_urls [Boolean] Whether or not URLs are banned in this chat
+      #
+      #   @param banned_words [Array<String>] List of banned words in this chat
+      #
+      #   @param experience [WhopSDK::Models::ChatChannelListResponse::Experience] The experience for this chat
+      #
+      #   @param user_posts_cooldown_seconds [Integer, nil] The number of seconds a user needs to wait before posting again, if any
+      #
+      #   @param who_can_post [Symbol, WhopSDK::Models::WhoCanPost] Who can post on this chat
+      #
+      #   @param who_can_react [Symbol, WhopSDK::Models::WhoCanReact] Who can react on this chat
+
+      # @see WhopSDK::Models::ChatChannelListResponse#experience
+      class Experience < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID representing this experience
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The written name of the description.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   The experience for this chat
+        #
+        #   @param id [String] The unique ID representing this experience
+        #
+        #   @param name [String] The written name of the description.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/chat_channel_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ChatChannels#retrieve
+    class ChatChannelRetrieveParams < 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/chat_channel_update_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ChatChannels#update
+    class ChatChannelUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute ban_media
+      #   Whether media uploads are banned in this chat
+      #
+      #   @return [Boolean, nil]
+      optional :ban_media, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute ban_urls
+      #   Whether URLs are banned in this chat
+      #
+      #   @return [Boolean, nil]
+      optional :ban_urls, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute banned_words
+      #   List of banned words for this chat
+      #
+      #   @return [Array<String>, nil]
+      optional :banned_words, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute user_posts_cooldown_seconds
+      #   The cooldown period in seconds between user posts
+      #
+      #   @return [Integer, nil]
+      optional :user_posts_cooldown_seconds, Integer, nil?: true
+
+      # @!attribute who_can_post
+      #   Who can post on a chat feed
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPost, nil]
+      optional :who_can_post, enum: -> { WhopSDK::WhoCanPost }, nil?: true
+
+      # @!attribute who_can_react
+      #   Who can react on a chat feed
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanReact, nil]
+      optional :who_can_react, enum: -> { WhopSDK::WhoCanReact }, nil?: true
+
+      # @!method initialize(ban_media: nil, ban_urls: nil, banned_words: nil, user_posts_cooldown_seconds: nil, who_can_post: nil, who_can_react: nil, request_options: {})
+      #   @param ban_media [Boolean, nil] Whether media uploads are banned in this chat
+      #
+      #   @param ban_urls [Boolean, nil] Whether URLs are banned in this chat
+      #
+      #   @param banned_words [Array<String>, nil] List of banned words for this chat
+      #
+      #   @param user_posts_cooldown_seconds [Integer, nil] The cooldown period in seconds between user posts
+      #
+      #   @param who_can_post [Symbol, WhopSDK::Models::WhoCanPost, nil] Who can post on a chat feed
+      #
+      #   @param who_can_react [Symbol, WhopSDK::Models::WhoCanReact, nil] Who can react on a chat feed
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end