whop_sdk 0.0.2

data/lib/whop_sdk/models/app_build_list_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AppBuilds#list
+    class AppBuildListResponse < 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::AppBuildListResponse} 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_platforms.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different platforms an app build can target.
+    module AppBuildPlatforms
+      extend WhopSDK::Internal::Type::Enum
+
+      IOS = :ios
+      ANDROID = :android
+      WEB = :web
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/app_build_promote_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::AppBuilds#promote
+    class AppBuildPromoteParams < 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/app_build_retrieve_params.rb

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different statuses an AppBuild can be in.
+    module AppBuildStatuses
+      extend WhopSDK::Internal::Type::Enum
+
+      DRAFT = :draft
+      PENDING = :pending
+      APPROVED = :approved
+      REJECTED = :rejected
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/app_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Apps#create
+    class AppCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to create the app for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute name
+      #   The name of the app to be created
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute base_url
+      #   The base URL of the app to be created
+      #
+      #   @return [String, nil]
+      optional :base_url, String, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/whop_sdk/models/app_list_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Apps#list
+    class AppListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!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 company_id
+      #   The ID of the company to filter apps by
+      #
+      #   @return [String, nil]
+      optional :company_id, String, nil?: true
+
+      # @!attribute direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, 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 order
+      #   The order to fetch the apps in for discovery.
+      #
+      #   @return [Symbol, WhopSDK::Models::AppListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::AppListParams::Order }, nil?: true
+
+      # @!attribute query
+      #   The query to search for apps by name.
+      #
+      #   @return [String, nil]
+      optional :query, String, nil?: true
+
+      # @!attribute verified_apps_only
+      #   If true, you will only get apps that are verified by Whop. Use this to populate
+      #   a 'featured apps' section on the app store.
+      #
+      #   @return [Boolean, nil]
+      optional :verified_apps_only, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute view_type
+      #   The different types of an app view
+      #
+      #   @return [Symbol, WhopSDK::Models::AppViewType, nil]
+      optional :view_type, enum: -> { WhopSDK::AppViewType }, nil?: true
+
+      # @!method initialize(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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AppListParams} for more details.
+      #
+      #   @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}]
+
+      # The order to fetch the apps in for discovery.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        DISCOVERABLE_AT = :discoverable_at
+        TOTAL_INSTALLS_LAST_30_DAYS = :total_installs_last_30_days
+        TIME_SPENT = :time_spent
+        TIME_SPENT_LAST_24_HOURS = :time_spent_last_24_hours
+        DAILY_ACTIVE_USERS = :daily_active_users
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/app_list_response.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Apps#list
+    class AppListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the app
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!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::AppListResponse::Company]
+      required :company, -> { WhopSDK::Models::AppListResponse::Company }
+
+      # @!attribute creator
+      #   The creator of the app
+      #
+      #   @return [WhopSDK::Models::AppListResponse::Creator]
+      required :creator, -> { WhopSDK::Models::AppListResponse::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::AppListResponse::Icon, nil]
+      required :icon, -> { WhopSDK::Models::AppListResponse::Icon }, nil?: true
+
+      # @!attribute name
+      #   The name of the app
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!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:, base_url:, company:, creator:, dashboard_path:, description:, discover_path:, domain_id:, experience_path:, icon:, name:, status:, verified:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AppListResponse} for more details.
+      #
+      #   An object representing an app
+      #
+      #   @param id [String] The ID of the app
+      #
+      #   @param base_url [String, nil] The base url of the app
+      #
+      #   @param company [WhopSDK::Models::AppListResponse::Company] The company that owns the app
+      #
+      #   @param creator [WhopSDK::Models::AppListResponse::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::AppListResponse::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 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::AppListResponse#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::AppListResponse#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::AppListResponse#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::AppListResponse::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
+    end
+  end
+end

data/lib/whop_sdk/models/app_retrieve_params.rb

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The status of an experience interface
+    module AppStatuses
+      extend WhopSDK::Internal::Type::Enum
+
+      LIVE = :live
+      UNLISTED = :unlisted
+      HIDDEN = :hidden
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/app_update_params.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Apps#update
+    class AppUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute app_store_description
+      #   The description of the app for the app store in-depth app view.
+      #
+      #   @return [String, nil]
+      optional :app_store_description, String, nil?: true
+
+      # @!attribute base_url
+      #   The base production url of the app
+      #
+      #   @return [String, nil]
+      optional :base_url, String, nil?: true
+
+      # @!attribute dashboard_path
+      #   The path for the dashboard view of the app
+      #
+      #   @return [String, nil]
+      optional :dashboard_path, String, nil?: true
+
+      # @!attribute description
+      #   The description of the app
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute discover_path
+      #   The path for the discover view of the app
+      #
+      #   @return [String, nil]
+      optional :discover_path, String, nil?: true
+
+      # @!attribute experience_path
+      #   The path for the hub view of the app
+      #
+      #   @return [String, nil]
+      optional :experience_path, String, nil?: true
+
+      # @!attribute icon
+      #   The icon for the app
+      #
+      #   @return [WhopSDK::Models::AppUpdateParams::Icon, nil]
+      optional :icon, -> { WhopSDK::AppUpdateParams::Icon }, nil?: true
+
+      # @!attribute name
+      #   The name of the app
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute required_scopes
+      #   The scopes that the app will request off of users when a user installs the app.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::AppUpdateParams::RequiredScope>, nil]
+      optional :required_scopes,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AppUpdateParams::RequiredScope] },
+               nil?: true
+
+      # @!attribute status
+      #   The status of an experience interface
+      #
+      #   @return [Symbol, WhopSDK::Models::AppStatuses, nil]
+      optional :status, enum: -> { WhopSDK::AppStatuses }, nil?: true
+
+      # @!method initialize(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 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}]
+
+      class Icon < 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::AppUpdateParams::Icon} for more details.
+        #
+        #   The icon for the app
+        #
+        #   @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
+
+      # These are the scopes an app can request on behalf of a user
+      module RequiredScope
+        extend WhopSDK::Internal::Type::Enum
+
+        READ_USER = :read_user
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end