whop_sdk 0.0.2

data/rbi/whop_sdk/models/app.rbi

@@ -0,0 +1,487 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class App < WhopSDK::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(WhopSDK::App, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the app
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API key for the app
+      sig { returns(T.nilable(WhopSDK::App::APIKey)) }
+      attr_reader :api_key
+
+      sig { params(api_key: T.nilable(WhopSDK::App::APIKey::OrHash)).void }
+      attr_writer :api_key
+
+      # The base url of the app
+      sig { returns(T.nilable(String)) }
+      attr_accessor :base_url
+
+      # The company that owns the app
+      sig { returns(WhopSDK::App::Company) }
+      attr_reader :company
+
+      sig { params(company: WhopSDK::App::Company::OrHash).void }
+      attr_writer :company
+
+      # The creator of the app
+      sig { returns(WhopSDK::App::Creator) }
+      attr_reader :creator
+
+      sig { params(creator: WhopSDK::App::Creator::OrHash).void }
+      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::App::Icon)) }
+      attr_reader :icon
+
+      sig { params(icon: T.nilable(WhopSDK::App::Icon::OrHash)).void }
+      attr_writer :icon
+
+      # The name of the app
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The set of permissions that an app requests to be granted when a user installs
+      # the app.
+      sig { returns(T::Array[WhopSDK::App::RequestedPermission]) }
+      attr_accessor :requested_permissions
+
+      # A collection of stats for the app.
+      sig { returns(T.nilable(WhopSDK::App::Stats)) }
+      attr_reader :stats
+
+      sig { params(stats: T.nilable(WhopSDK::App::Stats::OrHash)).void }
+      attr_writer :stats
+
+      # 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,
+          api_key: T.nilable(WhopSDK::App::APIKey::OrHash),
+          base_url: T.nilable(String),
+          company: WhopSDK::App::Company::OrHash,
+          creator: WhopSDK::App::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::App::Icon::OrHash),
+          name: String,
+          requested_permissions:
+            T::Array[WhopSDK::App::RequestedPermission::OrHash],
+          stats: T.nilable(WhopSDK::App::Stats::OrHash),
+          status: WhopSDK::AppStatuses::OrSymbol,
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the app
+        id:,
+        # The API key for the app
+        api_key:,
+        # 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:,
+        # The set of permissions that an app requests to be granted when a user installs
+        # the app.
+        requested_permissions:,
+        # A collection of stats for the app.
+        stats:,
+        # 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,
+            api_key: T.nilable(WhopSDK::App::APIKey),
+            base_url: T.nilable(String),
+            company: WhopSDK::App::Company,
+            creator: WhopSDK::App::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::App::Icon),
+            name: String,
+            requested_permissions: T::Array[WhopSDK::App::RequestedPermission],
+            stats: T.nilable(WhopSDK::App::Stats),
+            status: WhopSDK::AppStatuses::TaggedSymbol,
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class APIKey < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::App::APIKey, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of this API key
+        sig { returns(String) }
+        attr_accessor :id
+
+        # This is the API key used to authenticate requests
+        sig { returns(String) }
+        attr_accessor :token
+
+        # When this API key was created at
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The API key for the app
+        sig do
+          params(id: String, token: String, created_at: Time).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of this API key
+          id:,
+          # This is the API key used to authenticate requests
+          token:,
+          # When this API key was created at
+          created_at:
+        )
+        end
+
+        sig do
+          override.returns({ id: String, token: String, created_at: Time })
+        end
+        def to_hash
+        end
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::App::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::App::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 { T.any(WhopSDK::App::Icon, WhopSDK::Internal::AnyHash) }
+
+        # 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
+
+      class RequestedPermission < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::App::RequestedPermission, WhopSDK::Internal::AnyHash)
+          end
+
+        # Whether the action is required for the app to function.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_required
+
+        # The reason for requesting the action.
+        sig { returns(String) }
+        attr_accessor :justification
+
+        # The action that the app will request off of users when a user installs the app.
+        sig { returns(WhopSDK::App::RequestedPermission::PermissionAction) }
+        attr_reader :permission_action
+
+        sig do
+          params(
+            permission_action:
+              WhopSDK::App::RequestedPermission::PermissionAction::OrHash
+          ).void
+        end
+        attr_writer :permission_action
+
+        # A permission that the app requests from the admin of a company during the oauth
+        # flow.
+        sig do
+          params(
+            is_required: T::Boolean,
+            justification: String,
+            permission_action:
+              WhopSDK::App::RequestedPermission::PermissionAction::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the action is required for the app to function.
+          is_required:,
+          # The reason for requesting the action.
+          justification:,
+          # The action that the app will request off of users when a user installs the app.
+          permission_action:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              is_required: T::Boolean,
+              justification: String,
+              permission_action:
+                WhopSDK::App::RequestedPermission::PermissionAction
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PermissionAction < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::App::RequestedPermission::PermissionAction,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The identifier of the action.
+          sig { returns(String) }
+          attr_accessor :action
+
+          # The human readable name of the action.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # The action that the app will request off of users when a user installs the app.
+          sig { params(action: String, name: String).returns(T.attached_class) }
+          def self.new(
+            # The identifier of the action.
+            action:,
+            # The human readable name of the action.
+            name:
+          )
+          end
+
+          sig { override.returns({ action: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+
+      class Stats < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::App::Stats, WhopSDK::Internal::AnyHash)
+          end
+
+        # This is the number of users that have spent time in this app in the last 24
+        # hours.
+        sig { returns(Integer) }
+        attr_accessor :dau
+
+        # This is the number of users that have spent time in this app in the last 28
+        # days.
+        sig { returns(Integer) }
+        attr_accessor :mau
+
+        # This how much time, in seconds, users have spent in this app in the last 24
+        # hours.
+        sig { returns(Integer) }
+        attr_accessor :time_spent_last24_hours
+
+        # This is the number of users that have spent time in this app in the last 7 days.
+        sig { returns(Integer) }
+        attr_accessor :wau
+
+        # A collection of stats for the app.
+        sig do
+          params(
+            dau: Integer,
+            mau: Integer,
+            time_spent_last24_hours: Integer,
+            wau: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # This is the number of users that have spent time in this app in the last 24
+          # hours.
+          dau:,
+          # This is the number of users that have spent time in this app in the last 28
+          # days.
+          mau:,
+          # This how much time, in seconds, users have spent in this app in the last 24
+          # hours.
+          time_spent_last24_hours:,
+          # This is the number of users that have spent time in this app in the last 7 days.
+          wau:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dau: Integer,
+              mau: Integer,
+              time_spent_last24_hours: Integer,
+              wau: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/app_build.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class AppBuild < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::AppBuild, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the app build. It will look like apbu_xxxxx.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # This is generated by the client and used to verify the integrity of the file
+      # that is submitted. It is a SHA256 hash of the app build file.
+      sig { returns(String) }
+      attr_accessor :checksum
+
+      # When this app build was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The URL to download the app build .zip file.
+      sig { returns(String) }
+      attr_accessor :file_url
+
+      # Whether this app build is currently being used in production.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_production
+
+      # The platform of the app build (ios, android, web)
+      sig { returns(WhopSDK::AppBuildPlatforms::TaggedSymbol) }
+      attr_accessor :platform
+
+      # The review message for the app build, if any. This is populated when the build
+      # is rejected and there is a reason specified by the reviewer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :review_message
+
+      # The status of the app build (draft, approved, rejected, pending, etc)
+      sig { returns(WhopSDK::AppBuildStatuses::TaggedSymbol) }
+      attr_accessor :status
+
+      # The supported app view types for the app build. These are the views that the
+      # developer has specified that this build supports.
+      sig { returns(T::Array[WhopSDK::AppViewType::TaggedSymbol]) }
+      attr_accessor :supported_app_view_types
+
+      # An App Build object representing a build of an application
+      sig do
+        params(
+          id: String,
+          checksum: String,
+          created_at: Time,
+          file_url: String,
+          is_production: T::Boolean,
+          platform: WhopSDK::AppBuildPlatforms::OrSymbol,
+          review_message: T.nilable(String),
+          status: WhopSDK::AppBuildStatuses::OrSymbol,
+          supported_app_view_types: T::Array[WhopSDK::AppViewType::OrSymbol]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the app build. It will look like apbu_xxxxx.
+        id:,
+        # This is generated by the client and used to verify the integrity of the file
+        # that is submitted. It is a SHA256 hash of the app build file.
+        checksum:,
+        # When this app build was created.
+        created_at:,
+        # The URL to download the app build .zip file.
+        file_url:,
+        # Whether this app build is currently being used in production.
+        is_production:,
+        # The platform of the app build (ios, android, web)
+        platform:,
+        # The review message for the app build, if any. This is populated when the build
+        # is rejected and there is a reason specified by the reviewer.
+        review_message:,
+        # The status of the app build (draft, approved, rejected, pending, etc)
+        status:,
+        # The supported app view types for the app build. These are the views that the
+        # developer has specified that this build supports.
+        supported_app_view_types:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            checksum: String,
+            created_at: Time,
+            file_url: String,
+            is_production: T::Boolean,
+            platform: WhopSDK::AppBuildPlatforms::TaggedSymbol,
+            review_message: T.nilable(String),
+            status: WhopSDK::AppBuildStatuses::TaggedSymbol,
+            supported_app_view_types:
+              T::Array[WhopSDK::AppViewType::TaggedSymbol]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end