whop_sdk 0.0.2

data/lib/whop_sdk/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Internal
+    extend WhopSDK::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{WhopSDK::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, WhopSDK::FilePart) }
+    end
+  end
+end

data/lib/whop_sdk/models/access_level.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The access level a given user (or company) has to an access pass or company.
+    module AccessLevel
+      extend WhopSDK::Internal::Type::Enum
+
+      NO_ACCESS = :no_access
+      ADMIN = :admin
+      CUSTOMER = :customer
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/access_pass_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different types an access pass can be.
+    module AccessPassType
+      extend WhopSDK::Internal::Type::Enum
+
+      REGULAR = :regular
+      APP = :app
+      EXPERIENCE_UPSELL = :experience_upsell
+      API_ONLY = :api_only
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/app.rb

@@ -0,0 +1,351 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class App < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the app
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_key
+      #   The API key for the app
+      #
+      #   @return [WhopSDK::Models::App::APIKey, nil]
+      required :api_key, -> { WhopSDK::App::APIKey }, nil?: true
+
+      # @!attribute base_url
+      #   The base url of the app
+      #
+      #   @return [String, nil]
+      required :base_url, String, nil?: true
+
+      # @!attribute company
+      #   The company that owns the app
+      #
+      #   @return [WhopSDK::Models::App::Company]
+      required :company, -> { WhopSDK::App::Company }
+
+      # @!attribute creator
+      #   The creator of the app
+      #
+      #   @return [WhopSDK::Models::App::Creator]
+      required :creator, -> { WhopSDK::App::Creator }
+
+      # @!attribute dashboard_path
+      #   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]
+      #
+      #   @return [String, nil]
+      required :dashboard_path, String, nil?: true
+
+      # @!attribute description
+      #   The description of the app
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute discover_path
+      #   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]
+      #
+      #   @return [String, nil]
+      required :discover_path, String, nil?: true
+
+      # @!attribute domain_id
+      #   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
+      #
+      #   @return [String]
+      required :domain_id, String
+
+      # @!attribute experience_path
+      #   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]
+      #
+      #   @return [String, nil]
+      required :experience_path, String, nil?: true
+
+      # @!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::App::Icon, nil]
+      required :icon, -> { WhopSDK::App::Icon }, nil?: true
+
+      # @!attribute name
+      #   The name of the app
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute requested_permissions
+      #   The set of permissions that an app requests to be granted when a user installs
+      #   the app.
+      #
+      #   @return [Array<WhopSDK::Models::App::RequestedPermission>]
+      required :requested_permissions,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::App::RequestedPermission] }
+
+      # @!attribute stats
+      #   A collection of stats for the app.
+      #
+      #   @return [WhopSDK::Models::App::Stats, nil]
+      required :stats, -> { WhopSDK::App::Stats }, nil?: true
+
+      # @!attribute status
+      #   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.
+      #
+      #   @return [Symbol, WhopSDK::Models::AppStatuses]
+      required :status, enum: -> { WhopSDK::AppStatuses }
+
+      # @!attribute verified
+      #   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.
+      #
+      #   @return [Boolean]
+      required :verified, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(id:, api_key:, base_url:, company:, creator:, dashboard_path:, description:, discover_path:, domain_id:, experience_path:, icon:, name:, requested_permissions:, stats:, status:, verified:)
+      #   Some parameter documentations has been truncated, see {WhopSDK::Models::App} for
+      #   more details.
+      #
+      #   An object representing an app
+      #
+      #   @param id [String] The ID of the app
+      #
+      #   @param api_key [WhopSDK::Models::App::APIKey, nil] The API key for the app
+      #
+      #   @param base_url [String, nil] The base url of the app
+      #
+      #   @param company [WhopSDK::Models::App::Company] The company that owns the app
+      #
+      #   @param creator [WhopSDK::Models::App::Creator] The creator of the app
+      #
+      #   @param dashboard_path [String, nil] The path part for a specific view of the app. This is the template part of the u
+      #
+      #   @param description [String, nil] The description of the app
+      #
+      #   @param discover_path [String, nil] The path part for a specific view of the app. This is the template part of the u
+      #
+      #   @param domain_id [String] The unique part of the proxied domain for this app. Used to generate the base ur
+      #
+      #   @param experience_path [String, nil] The path part for a specific view of the app. This is the template part of the u
+      #
+      #   @param icon [WhopSDK::Models::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
+      #
+      #   @param requested_permissions [Array<WhopSDK::Models::App::RequestedPermission>] The set of permissions that an app requests to be granted when a user installs t
+      #
+      #   @param stats [WhopSDK::Models::App::Stats, nil] A collection of stats for the app.
+      #
+      #   @param status [Symbol, WhopSDK::Models::AppStatuses] If the status is live, the app is visible on Whop discovery. In order to be live
+      #
+      #   @param verified [Boolean] Whether this app has been verified by Whop. Verified apps are endorsed by whop a
+
+      # @see WhopSDK::Models::App#api_key
+      class APIKey < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of this API key
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute token
+        #   This is the API key used to authenticate requests
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute created_at
+        #   When this API key was created at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!method initialize(id:, token:, created_at:)
+        #   The API key for the app
+        #
+        #   @param id [String] The ID of this API key
+        #
+        #   @param token [String] This is the API key used to authenticate requests
+        #
+        #   @param created_at [Time] When this API key was created at
+      end
+
+      # @see WhopSDK::Models::App#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID (tag) of the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The company that owns the app
+        #
+        #   @param id [String] The ID (tag) of the company.
+        #
+        #   @param title [String] The title of the company.
+      end
+
+      # @see WhopSDK::Models::App#creator
+      class Creator < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!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:, name:, username:)
+        #   The creator of the app
+        #
+        #   @param id [String] The internal ID 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
+
+      # @see WhopSDK::Models::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::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
+
+      class RequestedPermission < WhopSDK::Internal::Type::BaseModel
+        # @!attribute is_required
+        #   Whether the action is required for the app to function.
+        #
+        #   @return [Boolean]
+        required :is_required, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute justification
+        #   The reason for requesting the action.
+        #
+        #   @return [String]
+        required :justification, String
+
+        # @!attribute permission_action
+        #   The action that the app will request off of users when a user installs the app.
+        #
+        #   @return [WhopSDK::Models::App::RequestedPermission::PermissionAction]
+        required :permission_action, -> { WhopSDK::App::RequestedPermission::PermissionAction }
+
+        # @!method initialize(is_required:, justification:, permission_action:)
+        #   A permission that the app requests from the admin of a company during the oauth
+        #   flow.
+        #
+        #   @param is_required [Boolean] Whether the action is required for the app to function.
+        #
+        #   @param justification [String] The reason for requesting the action.
+        #
+        #   @param permission_action [WhopSDK::Models::App::RequestedPermission::PermissionAction] The action that the app will request off of users when a user installs the app.
+
+        # @see WhopSDK::Models::App::RequestedPermission#permission_action
+        class PermissionAction < WhopSDK::Internal::Type::BaseModel
+          # @!attribute action
+          #   The identifier of the action.
+          #
+          #   @return [String]
+          required :action, String
+
+          # @!attribute name
+          #   The human readable name of the action.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(action:, name:)
+          #   The action that the app will request off of users when a user installs the app.
+          #
+          #   @param action [String] The identifier of the action.
+          #
+          #   @param name [String] The human readable name of the action.
+        end
+      end
+
+      # @see WhopSDK::Models::App#stats
+      class Stats < WhopSDK::Internal::Type::BaseModel
+        # @!attribute dau
+        #   This is the number of users that have spent time in this app in the last 24
+        #   hours.
+        #
+        #   @return [Integer]
+        required :dau, Integer
+
+        # @!attribute mau
+        #   This is the number of users that have spent time in this app in the last 28
+        #   days.
+        #
+        #   @return [Integer]
+        required :mau, Integer
+
+        # @!attribute time_spent_last24_hours
+        #   This how much time, in seconds, users have spent in this app in the last 24
+        #   hours.
+        #
+        #   @return [Integer]
+        required :time_spent_last24_hours, Integer
+
+        # @!attribute wau
+        #   This is the number of users that have spent time in this app in the last 7 days.
+        #
+        #   @return [Integer]
+        required :wau, Integer
+
+        # @!method initialize(dau:, mau:, time_spent_last24_hours:, wau:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::App::Stats} for more details.
+        #
+        #   A collection of stats for the app.
+        #
+        #   @param dau [Integer] This is the number of users that have spent time in this app in the last 24 hour
+        #
+        #   @param mau [Integer] This is the number of users that have spent time in this app in the last 28 days
+        #
+        #   @param time_spent_last24_hours [Integer] This how much time, in seconds, users have spent in this app in the last 24 hour
+        #
+        #   @param wau [Integer] This is the number of users that have spent time in this app in the last 7 days.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/app_build.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class AppBuild < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the app build. It will look like apbu_xxxxx.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute checksum
+      #   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.
+      #
+      #   @return [String]
+      required :checksum, String
+
+      # @!attribute created_at
+      #   When this app build was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute file_url
+      #   The URL to download the app build .zip file.
+      #
+      #   @return [String]
+      required :file_url, String
+
+      # @!attribute is_production
+      #   Whether this app build is currently being used in production.
+      #
+      #   @return [Boolean]
+      required :is_production, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute platform
+      #   The platform of the app build (ios, android, web)
+      #
+      #   @return [Symbol, WhopSDK::Models::AppBuildPlatforms]
+      required :platform, enum: -> { WhopSDK::AppBuildPlatforms }
+
+      # @!attribute review_message
+      #   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.
+      #
+      #   @return [String, nil]
+      required :review_message, String, nil?: true
+
+      # @!attribute status
+      #   The status of the app build (draft, approved, rejected, pending, etc)
+      #
+      #   @return [Symbol, WhopSDK::Models::AppBuildStatuses]
+      required :status, enum: -> { WhopSDK::AppBuildStatuses }
+
+      # @!attribute supported_app_view_types
+      #   The supported app view types for the app build. These are the views that the
+      #   developer has specified that this build supports.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::AppViewType>]
+      required :supported_app_view_types, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AppViewType] }
+
+      # @!method initialize(id:, checksum:, created_at:, file_url:, is_production:, platform:, review_message:, status:, supported_app_view_types:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AppBuild} for more details.
+      #
+      #   An App Build object representing a build of an application
+      #
+      #   @param id [String] The ID of the app build. It will look like apbu_xxxxx.
+      #
+      #   @param checksum [String] This is generated by the client and used to verify the integrity of the file tha
+      #
+      #   @param created_at [Time] When this app build was created.
+      #
+      #   @param file_url [String] The URL to download the app build .zip file.
+      #
+      #   @param is_production [Boolean] Whether this app build is currently being used in production.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::AppBuildPlatforms] The platform of the app build (ios, android, web)
+      #
+      #   @param review_message [String, nil] The review message for the app build, if any. This is populated when the build i
+      #
+      #   @param status [Symbol, WhopSDK::Models::AppBuildStatuses] The status of the app build (draft, approved, rejected, pending, etc)
+      #
+      #   @param supported_app_view_types [Array<Symbol, WhopSDK::Models::AppViewType>] The supported app view types for the app build. These are the views that the dev
+    end
+  end
+end

data/lib/whop_sdk/models/app_build_create_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AppBuilds#create
+    class AppBuildCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute attachment
+      #   Attachment input for the app build file. This should be an upload in .zip
+      #   format. The zip should contain at least one main_js_bundle.hbc file and
+      #   optionally an assets folder next to it.
+      #
+      #   @return [WhopSDK::Models::AppBuildCreateParams::Attachment]
+      required :attachment, -> { WhopSDK::AppBuildCreateParams::Attachment }
+
+      # @!attribute checksum
+      #   Checksum of the app build file. This is generated by the client and used to
+      #   verify the integrity of the file that is submitted when un-packaged later on a
+      #   device.
+      #
+      #   @return [String]
+      required :checksum, String
+
+      # @!attribute platform
+      #   The platform of the app build (ios, android, web)
+      #
+      #   @return [Symbol, WhopSDK::Models::AppBuildPlatforms]
+      required :platform, enum: -> { WhopSDK::AppBuildPlatforms }
+
+      # @!attribute app_id
+      #   The ID of the app to create a build for. By default the current app from the api
+      #   key is used.
+      #
+      #   @return [String, nil]
+      optional :app_id, String, nil?: true
+
+      # @!attribute supported_app_view_types
+      #   Supported app view types for the app build. A build can specify multiple view
+      #   types, but should only specify ones that its code supports.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::AppViewType>, nil]
+      optional :supported_app_view_types,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AppViewType] },
+               nil?: true
+
+      # @!method initialize(attachment:, checksum:, platform:, app_id: nil, supported_app_view_types: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AppBuildCreateParams} for more details.
+      #
+      #   @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}]
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute direct_upload_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.
+        #
+        #   @return [String, nil]
+        optional :direct_upload_id, String, nil?: true
+
+        # @!method initialize(id: nil, direct_upload_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::AppBuildCreateParams::Attachment} for more details.
+        #
+        #   Attachment input for the app build file. This should be an upload in .zip
+        #   format. The zip should contain at least one main_js_bundle.hbc file and
+        #   optionally an assets folder next to it.
+        #
+        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+        #
+        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/app_build_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AppBuilds#list
+    class AppBuildListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute app_id
+      #   The ID of the app to filter app builds by
+      #
+      #   @return [String]
+      required :app_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 platform
+      #   The different platforms an app build can target.
+      #
+      #   @return [Symbol, WhopSDK::Models::AppBuildPlatforms, nil]
+      optional :platform, enum: -> { WhopSDK::AppBuildPlatforms }, nil?: true
+
+      # @!attribute status
+      #   The different statuses an AppBuild can be in.
+      #
+      #   @return [Symbol, WhopSDK::Models::AppBuildStatuses, nil]
+      optional :status, enum: -> { WhopSDK::AppBuildStatuses }, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end