whop_sdk 0.0.2

data/lib/whop_sdk/resources/app_builds.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class AppBuilds
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::AppBuildCreateParams} for more details.
+      #
+      # Creates a new app build
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_builds`
+      #
+      # @overload create(attachment:, checksum:, platform:, app_id: nil, supported_app_view_types: nil, request_options: {})
+      #
+      # @param attachment [WhopSDK::Models::AppBuildCreateParams::Attachment] Attachment input for the app build file. This should be an upload in .zip format
+      #
+      # @param checksum [String] Checksum of the app build file. This is generated by the client and used to veri
+      #
+      # @param platform [Symbol, WhopSDK::Models::AppBuildPlatforms] The platform of the app build (ios, android, web)
+      #
+      # @param app_id [String, nil] The ID of the app to create a build for. By default the current app from the api
+      #
+      # @param supported_app_view_types [Array<Symbol, WhopSDK::Models::AppViewType>, nil] Supported app view types for the app build. A build can specify multiple view ty
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::AppBuild]
+      #
+      # @see WhopSDK::Models::AppBuildCreateParams
+      def create(params)
+        parsed, options = WhopSDK::AppBuildCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "app_builds",
+          body: parsed,
+          model: WhopSDK::AppBuild,
+          options: options
+        )
+      end
+
+      # Retrieves an app build by ID
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_builds`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::AppBuild]
+      #
+      # @see WhopSDK::Models::AppBuildRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["app_builds/%1$s", id],
+          model: WhopSDK::AppBuild,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists app builds for an app
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_builds`
+      #
+      # @overload list(app_id:, after: nil, before: nil, first: nil, last: nil, platform: nil, status: nil, request_options: {})
+      #
+      # @param app_id [String] The ID of the app to filter app builds by
+      #
+      # @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 platform [Symbol, WhopSDK::Models::AppBuildPlatforms, nil] The different platforms an app build can target.
+      #
+      # @param status [Symbol, WhopSDK::Models::AppBuildStatuses, nil] The different statuses an AppBuild can be in.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AppBuildListResponse>]
+      #
+      # @see WhopSDK::Models::AppBuildListParams
+      def list(params)
+        parsed, options = WhopSDK::AppBuildListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "app_builds",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::AppBuildListResponse,
+          options: options
+        )
+      end
+
+      # Promotes an app build to production
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_builds`
+      #
+      # @overload promote(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::AppBuild]
+      #
+      # @see WhopSDK::Models::AppBuildPromoteParams
+      def promote(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["app_builds/%1$s/promote", id],
+          model: WhopSDK::AppBuild,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/apps.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Apps
+      # Create a new App
+      #
+      # Required permissions:
+      #
+      # - `developer:create_app`
+      # - `developer:manage_api_key`
+      #
+      # @overload create(company_id:, name:, base_url: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to create the app for
+      #
+      # @param name [String] The name of the app to be created
+      #
+      # @param base_url [String, nil] The base URL of the app to be created
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::App]
+      #
+      # @see WhopSDK::Models::AppCreateParams
+      def create(params)
+        parsed, options = WhopSDK::AppCreateParams.dump_request(params)
+        @client.request(method: :post, path: "apps", body: parsed, model: WhopSDK::App, options: options)
+      end
+
+      # Retrieves an app by ID
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_api_key`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::App]
+      #
+      # @see WhopSDK::Models::AppRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["apps/%1$s", id],
+          model: WhopSDK::App,
+          options: params[:request_options]
+        )
+      end
+
+      # Update an existing App
+      #
+      # Required permissions:
+      #
+      # - `developer:update_app`
+      # - `developer:manage_api_key`
+      #
+      # @overload update(id, app_store_description: nil, base_url: nil, dashboard_path: nil, description: nil, discover_path: nil, experience_path: nil, icon: nil, name: nil, required_scopes: nil, status: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param app_store_description [String, nil] The description of the app for the app store in-depth app view.
+      #
+      # @param base_url [String, nil] The base production url of the app
+      #
+      # @param dashboard_path [String, nil] The path for the dashboard view of the app
+      #
+      # @param description [String, nil] The description of the app
+      #
+      # @param discover_path [String, nil] The path for the discover view of the app
+      #
+      # @param experience_path [String, nil] The path for the hub view of the app
+      #
+      # @param icon [WhopSDK::Models::AppUpdateParams::Icon, nil] The icon for the app
+      #
+      # @param name [String, nil] The name of the app
+      #
+      # @param required_scopes [Array<Symbol, WhopSDK::Models::AppUpdateParams::RequiredScope>, nil] The scopes that the app will request off of users when a user installs the app.
+      #
+      # @param status [Symbol, WhopSDK::Models::AppStatuses, nil] The status of an experience interface
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::App]
+      #
+      # @see WhopSDK::Models::AppUpdateParams
+      def update(id, params = {})
+        parsed, options = WhopSDK::AppUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["apps/%1$s", id],
+          body: parsed,
+          model: WhopSDK::App,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::AppListParams} for more details.
+      #
+      # Fetches a list of apps
+      #
+      # @overload list(after: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, verified_apps_only: nil, view_type: nil, request_options: {})
+      #
+      # @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 company_id [String, nil] The ID of the company to filter apps by
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @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 order [Symbol, WhopSDK::Models::AppListParams::Order, nil] The order to fetch the apps in for discovery.
+      #
+      # @param query [String, nil] The query to search for apps by name.
+      #
+      # @param verified_apps_only [Boolean, nil] If true, you will only get apps that are verified by Whop. Use this to populate
+      #
+      # @param view_type [Symbol, WhopSDK::Models::AppViewType, nil] The different types of an app view
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AppListResponse>]
+      #
+      # @see WhopSDK::Models::AppListParams
+      def list(params = {})
+        parsed, options = WhopSDK::AppListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "apps",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::AppListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/authorized_users.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class AuthorizedUsers
+      # Retrieves a authorized user by ID
+      #
+      # Required permissions:
+      #
+      # - `company:authorized_user:read`
+      # - `member:email:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::AuthorizedUserRetrieveResponse]
+      #
+      # @see WhopSDK::Models::AuthorizedUserRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["authorized_users/%1$s", id],
+          model: WhopSDK::Models::AuthorizedUserRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists authorized users
+      #
+      # Required permissions:
+      #
+      # - `company:authorized_user:read`
+      # - `member:email:read`
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AuthorizedUserListResponse>]
+      #
+      # @see WhopSDK::Models::AuthorizedUserListParams
+      def list(params)
+        parsed, options = WhopSDK::AuthorizedUserListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "authorized_users",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::AuthorizedUserListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/chat_channels.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class ChatChannels
+      # Retrieves a chat channel
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::ChatChannel]
+      #
+      # @see WhopSDK::Models::ChatChannelRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["chat_channels/%1$s", id],
+          model: WhopSDK::ChatChannel,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates a chat channel
+      #
+      # Required permissions:
+      #
+      # - `chat:moderate`
+      #
+      # @overload update(id, 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 id [String]
+      #
+      # @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}, nil]
+      #
+      # @return [WhopSDK::Models::ChatChannel]
+      #
+      # @see WhopSDK::Models::ChatChannelUpdateParams
+      def update(id, params = {})
+        parsed, options = WhopSDK::ChatChannelUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["chat_channels/%1$s", id],
+          body: parsed,
+          model: WhopSDK::ChatChannel,
+          options: options
+        )
+      end
+
+      # Lists chat channels inside a company
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ChatChannelListResponse>]
+      #
+      # @see WhopSDK::Models::ChatChannelListParams
+      def list(params)
+        parsed, options = WhopSDK::ChatChannelListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "chat_channels",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::ChatChannelListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/checkout_configurations.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class CheckoutConfigurations
+      # Creates a new checkout configuration
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:create`
+      # - `plan:create`
+      #
+      # @overload create(affiliate_code: nil, metadata: nil, plan: nil, plan_id: nil, redirect_url: nil, request_options: {})
+      #
+      # @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
+      #
+      # @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
+      #
+      # @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil] Pass this object to create a new plan for this checkout configuration
+      #
+      # @param plan_id [String, nil] The ID of the plan to use for the checkout configuration
+      #
+      # @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CheckoutConfiguration]
+      #
+      # @see WhopSDK::Models::CheckoutConfigurationCreateParams
+      def create(params = {})
+        parsed, options = WhopSDK::CheckoutConfigurationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "checkout_configurations",
+          body: parsed,
+          model: WhopSDK::CheckoutConfiguration,
+          options: options
+        )
+      end
+
+      # Retrieves a checkout configuration by ID
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:basic:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CheckoutConfiguration]
+      #
+      # @see WhopSDK::Models::CheckoutConfigurationRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["checkout_configurations/%1$s", id],
+          model: WhopSDK::CheckoutConfiguration,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists checkout configurations
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:basic:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list checkout configurations 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 direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @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 plan_id [String, nil] The ID of the plan to filter checkout configurations by
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CheckoutConfigurationListResponse>]
+      #
+      # @see WhopSDK::Models::CheckoutConfigurationListParams
+      def list(params)
+        parsed, options = WhopSDK::CheckoutConfigurationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "checkout_configurations",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::CheckoutConfigurationListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/companies.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Companies
+      # Retrieves an company by ID or its url route
+      #
+      # Required permissions:
+      #
+      # - `company:basic:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Company]
+      #
+      # @see WhopSDK::Models::CompanyRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["companies/%1$s", id],
+          model: WhopSDK::Company,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end