whop_sdk 0.0.2

data/rbi/whop_sdk/models/app_list_response.rbi

@@ -0,0 +1,280 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AppListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::AppListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the app
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The base url of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :base_url
+
+      # The company that owns the app
+      sig { returns(WhopSDK::Models::AppListResponse::Company) }
+      attr_reader :company
+
+      sig do
+        params(company: WhopSDK::Models::AppListResponse::Company::OrHash).void
+      end
+      attr_writer :company
+
+      # The creator of the app
+      sig { returns(WhopSDK::Models::AppListResponse::Creator) }
+      attr_reader :creator
+
+      sig do
+        params(creator: WhopSDK::Models::AppListResponse::Creator::OrHash).void
+      end
+      attr_writer :creator
+
+      # The path part for a specific view of the app. This is the template part of the
+      # url after the base domain. Eg: /experiences/[experienceId]
+      sig { returns(T.nilable(String)) }
+      attr_accessor :dashboard_path
+
+      # The description of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The path part for a specific view of the app. This is the template part of the
+      # url after the base domain. Eg: /experiences/[experienceId]
+      sig { returns(T.nilable(String)) }
+      attr_accessor :discover_path
+
+      # The unique part of the proxied domain for this app. Used to generate the base
+      # url used to display the app inside the whop platform. Refers to the id part in
+      # the final url: https://{domain_id}.apps.whop.com
+      sig { returns(String) }
+      attr_accessor :domain_id
+
+      # The path part for a specific view of the app. This is the template part of the
+      # url after the base domain. Eg: /experiences/[experienceId]
+      sig { returns(T.nilable(String)) }
+      attr_accessor :experience_path
+
+      # 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.
+      sig { returns(T.nilable(WhopSDK::Models::AppListResponse::Icon)) }
+      attr_reader :icon
+
+      sig do
+        params(
+          icon: T.nilable(WhopSDK::Models::AppListResponse::Icon::OrHash)
+        ).void
+      end
+      attr_writer :icon
+
+      # The name of the app
+      sig { returns(String) }
+      attr_accessor :name
+
+      # If the status is live, the app is visible on Whop discovery. In order to be
+      # live, you need to set the name, icon, and description. Being unlisted or hidden
+      # means it's not visible on Whop but you can still install the app via direct
+      # link. To remove the app from whop discovery, you should set the status to
+      # unlisted.
+      sig { returns(WhopSDK::AppStatuses::TaggedSymbol) }
+      attr_accessor :status
+
+      # Whether this app has been verified by Whop. Verified apps are endorsed by whop
+      # and are shown in the 'featured apps' section of the app store.
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      # An object representing an app
+      sig do
+        params(
+          id: String,
+          base_url: T.nilable(String),
+          company: WhopSDK::Models::AppListResponse::Company::OrHash,
+          creator: WhopSDK::Models::AppListResponse::Creator::OrHash,
+          dashboard_path: T.nilable(String),
+          description: T.nilable(String),
+          discover_path: T.nilable(String),
+          domain_id: String,
+          experience_path: T.nilable(String),
+          icon: T.nilable(WhopSDK::Models::AppListResponse::Icon::OrHash),
+          name: String,
+          status: WhopSDK::AppStatuses::OrSymbol,
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the app
+        id:,
+        # The base url of the app
+        base_url:,
+        # The company that owns the app
+        company:,
+        # The creator of the app
+        creator:,
+        # The path part for a specific view of the app. This is the template part of the
+        # url after the base domain. Eg: /experiences/[experienceId]
+        dashboard_path:,
+        # The description of the app
+        description:,
+        # The path part for a specific view of the app. This is the template part of the
+        # url after the base domain. Eg: /experiences/[experienceId]
+        discover_path:,
+        # The unique part of the proxied domain for this app. Used to generate the base
+        # url used to display the app inside the whop platform. Refers to the id part in
+        # the final url: https://{domain_id}.apps.whop.com
+        domain_id:,
+        # The path part for a specific view of the app. This is the template part of the
+        # url after the base domain. Eg: /experiences/[experienceId]
+        experience_path:,
+        # 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.
+        icon:,
+        # The name of the app
+        name:,
+        # If the status is live, the app is visible on Whop discovery. In order to be
+        # live, you need to set the name, icon, and description. Being unlisted or hidden
+        # means it's not visible on Whop but you can still install the app via direct
+        # link. To remove the app from whop discovery, you should set the status to
+        # unlisted.
+        status:,
+        # Whether this app has been verified by Whop. Verified apps are endorsed by whop
+        # and are shown in the 'featured apps' section of the app store.
+        verified:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            base_url: T.nilable(String),
+            company: WhopSDK::Models::AppListResponse::Company,
+            creator: WhopSDK::Models::AppListResponse::Creator,
+            dashboard_path: T.nilable(String),
+            description: T.nilable(String),
+            discover_path: T.nilable(String),
+            domain_id: String,
+            experience_path: T.nilable(String),
+            icon: T.nilable(WhopSDK::Models::AppListResponse::Icon),
+            name: String,
+            status: WhopSDK::AppStatuses::TaggedSymbol,
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AppListResponse::Company,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID (tag) of the company.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the company.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The company that owns the app
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The ID (tag) of the company.
+          id:,
+          # The title of the company.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class Creator < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AppListResponse::Creator,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The creator of the app
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Icon < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::AppListResponse::Icon,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # 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.
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/app_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AppRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AppRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/app_statuses.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The status of an experience interface
+    module AppStatuses
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::AppStatuses) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      LIVE = T.let(:live, WhopSDK::AppStatuses::TaggedSymbol)
+      UNLISTED = T.let(:unlisted, WhopSDK::AppStatuses::TaggedSymbol)
+      HIDDEN = T.let(:hidden, WhopSDK::AppStatuses::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::AppStatuses::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/app_update_params.rbi

@@ -0,0 +1,201 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AppUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AppUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The description of the app for the app store in-depth app view.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :app_store_description
+
+      # The base production url of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :base_url
+
+      # The path for the dashboard view of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :dashboard_path
+
+      # The description of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The path for the discover view of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :discover_path
+
+      # The path for the hub view of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :experience_path
+
+      # The icon for the app
+      sig { returns(T.nilable(WhopSDK::AppUpdateParams::Icon)) }
+      attr_reader :icon
+
+      sig do
+        params(icon: T.nilable(WhopSDK::AppUpdateParams::Icon::OrHash)).void
+      end
+      attr_writer :icon
+
+      # The name of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The scopes that the app will request off of users when a user installs the app.
+      sig do
+        returns(
+          T.nilable(T::Array[WhopSDK::AppUpdateParams::RequiredScope::OrSymbol])
+        )
+      end
+      attr_accessor :required_scopes
+
+      # The status of an experience interface
+      sig { returns(T.nilable(WhopSDK::AppStatuses::OrSymbol)) }
+      attr_accessor :status
+
+      sig do
+        params(
+          app_store_description: T.nilable(String),
+          base_url: T.nilable(String),
+          dashboard_path: T.nilable(String),
+          description: T.nilable(String),
+          discover_path: T.nilable(String),
+          experience_path: T.nilable(String),
+          icon: T.nilable(WhopSDK::AppUpdateParams::Icon::OrHash),
+          name: T.nilable(String),
+          required_scopes:
+            T.nilable(
+              T::Array[WhopSDK::AppUpdateParams::RequiredScope::OrSymbol]
+            ),
+          status: T.nilable(WhopSDK::AppStatuses::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The description of the app for the app store in-depth app view.
+        app_store_description: nil,
+        # The base production url of the app
+        base_url: nil,
+        # The path for the dashboard view of the app
+        dashboard_path: nil,
+        # The description of the app
+        description: nil,
+        # The path for the discover view of the app
+        discover_path: nil,
+        # The path for the hub view of the app
+        experience_path: nil,
+        # The icon for the app
+        icon: nil,
+        # The name of the app
+        name: nil,
+        # The scopes that the app will request off of users when a user installs the app.
+        required_scopes: nil,
+        # The status of an experience interface
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            app_store_description: T.nilable(String),
+            base_url: T.nilable(String),
+            dashboard_path: T.nilable(String),
+            description: T.nilable(String),
+            discover_path: T.nilable(String),
+            experience_path: T.nilable(String),
+            icon: T.nilable(WhopSDK::AppUpdateParams::Icon),
+            name: T.nilable(String),
+            required_scopes:
+              T.nilable(
+                T::Array[WhopSDK::AppUpdateParams::RequiredScope::OrSymbol]
+              ),
+            status: T.nilable(WhopSDK::AppStatuses::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Icon < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::AppUpdateParams::Icon, WhopSDK::Internal::AnyHash)
+          end
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :direct_upload_id
+
+        # The icon for the app
+        sig do
+          params(
+            id: T.nilable(String),
+            direct_upload_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          id: nil,
+          # 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.
+          direct_upload_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # These are the scopes an app can request on behalf of a user
+      module RequiredScope
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AppUpdateParams::RequiredScope)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        READ_USER =
+          T.let(
+            :read_user,
+            WhopSDK::AppUpdateParams::RequiredScope::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AppUpdateParams::RequiredScope::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/app_view_type.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different types of an app view
+    module AppViewType
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::AppViewType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      HUB = T.let(:hub, WhopSDK::AppViewType::TaggedSymbol)
+      DISCOVER = T.let(:discover, WhopSDK::AppViewType::TaggedSymbol)
+      DASH = T.let(:dash, WhopSDK::AppViewType::TaggedSymbol)
+      DASHBOARD = T.let(:dashboard, WhopSDK::AppViewType::TaggedSymbol)
+      ANALYTICS = T.let(:analytics, WhopSDK::AppViewType::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::AppViewType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/authorized_user_list_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AuthorizedUserListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::AuthorizedUserListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list authorized users for
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # Possible roles an authorized user can have
+      sig { returns(T.nilable(WhopSDK::AuthorizedUserRoles::OrSymbol)) }
+      attr_accessor :role
+
+      # Filter by the user ID to check if the user is an authorized user
+      sig { returns(T.nilable(String)) }
+      attr_accessor :user_id
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          role: T.nilable(WhopSDK::AuthorizedUserRoles::OrSymbol),
+          user_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to list authorized users for
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # Possible roles an authorized user can have
+        role: nil,
+        # Filter by the user ID to check if the user is an authorized user
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            role: T.nilable(WhopSDK::AuthorizedUserRoles::OrSymbol),
+            user_id: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end