whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/account_create_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#create
+    class AccountCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   The email address of the account owner. Required for business account API key
+      #   requests.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute metadata
+      #   Arbitrary key/value metadata to store on the account.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
+
+      # @!attribute title
+      #   The display name of the account. Defaults to `metadata.external_id` or the
+      #   owner's email when omitted.
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(email: nil, metadata: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::AccountCreateParams} for more details.
+      #
+      #   @param email [String] The email address of the account owner. Required for business account API key re
+      #
+      #   @param metadata [Hash{Symbol=>Object}] Arbitrary key/value metadata to store on the account.
+      #
+      #   @param title [String] The display name of the account. Defaults to `metadata.external_id` or the owner
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/account_list_params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#list
+    class AccountListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   A cursor; returns accounts after this position.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   A cursor; returns accounts before this position.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute direction
+      #   Sort direction.
+      #
+      #   @return [Symbol, WhopSDK::Models::AccountListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::AccountListParams::Direction }
+
+      # @!attribute first
+      #   The number of accounts to return (default 10, max 50).
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute last
+      #   The number of accounts to return from the end of the range.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer
+
+      # @!attribute order
+      #   The field to sort accounts by.
+      #
+      #   @return [Symbol, WhopSDK::Models::AccountListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::AccountListParams::Order }
+
+      # @!method initialize(after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, request_options: {})
+      #   @param after [String] A cursor; returns accounts after this position.
+      #
+      #   @param before [String] A cursor; returns accounts before this position.
+      #
+      #   @param direction [Symbol, WhopSDK::Models::AccountListParams::Direction] Sort direction.
+      #
+      #   @param first [Integer] The number of accounts to return (default 10, max 50).
+      #
+      #   @param last [Integer] The number of accounts to return from the end of the range.
+      #
+      #   @param order [Symbol, WhopSDK::Models::AccountListParams::Order] The field to sort accounts by.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Sort direction.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The field to sort accounts by.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/account_me_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#me
+    class AccountMeParams < 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/account_recommend_actions_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#recommend_actions
+    class AccountRecommendActionsParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String]
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/account_recommend_actions_response.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#recommend_actions
+    class AccountRecommendActionsResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<WhopSDK::Models::AccountRecommendActionsResponse::Data>]
+      required :data,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AccountRecommendActionsResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<WhopSDK::Models::AccountRecommendActionsResponse::Data>]
+
+      class Data < WhopSDK::Internal::Type::BaseModel
+        # @!attribute action
+        #   The recommendation; new values may be added, so handle unknown actions
+        #   gracefully
+        #
+        #   @return [Symbol, WhopSDK::Models::AccountRecommendActionsResponse::Data::Action]
+        required :action, enum: -> { WhopSDK::Models::AccountRecommendActionsResponse::Data::Action }
+
+        # @!attribute blocked_capabilities
+        #
+        #   @return [Array<String>]
+        required :blocked_capabilities, WhopSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute cta
+        #   The URL the call-to-action links to
+        #
+        #   @return [String]
+        required :cta, String
+
+        # @!attribute cta_label
+        #   Button label
+        #
+        #   @return [String]
+        required :cta_label, String
+
+        # @!attribute description
+        #   Supporting copy, or empty
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute icon_url
+        #   Illustration icon URL, or `null`
+        #
+        #   @return [String, nil]
+        required :icon_url, String, nil?: true
+
+        # @!attribute impact_score
+        #   Estimated revenue impact from 0-100, comparable across accounts, or `null` when
+        #   not ranked
+        #
+        #   @return [Integer, nil]
+        required :impact_score, Integer, nil?: true
+
+        # @!attribute reasoning
+        #   Why this action was recommended for this account, or `null`
+        #
+        #   @return [String, nil]
+        required :reasoning, String, nil?: true
+
+        # @!attribute status
+        #   Always optional — never blocking
+        #
+        #   @return [Symbol, WhopSDK::Models::AccountRecommendActionsResponse::Data::Status]
+        required :status, enum: -> { WhopSDK::Models::AccountRecommendActionsResponse::Data::Status }
+
+        # @!attribute title
+        #   Headline for the recommendation
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, impact_score:, reasoning:, status:, title:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::AccountRecommendActionsResponse::Data} for more details.
+        #
+        #   @param action [Symbol, WhopSDK::Models::AccountRecommendActionsResponse::Data::Action] The recommendation; new values may be added, so handle unknown actions gracefull
+        #
+        #   @param blocked_capabilities [Array<String>]
+        #
+        #   @param cta [String] The URL the call-to-action links to
+        #
+        #   @param cta_label [String] Button label
+        #
+        #   @param description [String] Supporting copy, or empty
+        #
+        #   @param icon_url [String, nil] Illustration icon URL, or `null`
+        #
+        #   @param impact_score [Integer, nil] Estimated revenue impact from 0-100, comparable across accounts, or `null` when
+        #
+        #   @param reasoning [String, nil] Why this action was recommended for this account, or `null`
+        #
+        #   @param status [Symbol, WhopSDK::Models::AccountRecommendActionsResponse::Data::Status] Always optional — never blocking
+        #
+        #   @param title [String] Headline for the recommendation
+
+        # The recommendation; new values may be added, so handle unknown actions
+        # gracefully
+        #
+        # @see WhopSDK::Models::AccountRecommendActionsResponse::Data#action
+        module Action
+          extend WhopSDK::Internal::Type::Enum
+
+          THEME_BUSINESS = :theme_business
+          CREATE_PRODUCT = :create_product
+          CREATE_PLAN = :create_plan
+          VERIFY_IDENTITY = :verify_identity
+          CONNECT_AFFILIATE_PROGRAM = :connect_affiliate_program
+          CREATE_PROMOTION = :create_promotion
+          SETUP_TRACKING_PIXEL = :setup_tracking_pixel
+          MIGRATE_FROM_STRIPE = :migrate_from_stripe
+          ACCEPT_FIRST_PAYMENT = :accept_first_payment
+          LAUNCH_FIRST_AD = :launch_first_ad
+          INVITE_TEAM_MEMBER = :invite_team_member
+          ENABLE_TAX_COLLECTION = :enable_tax_collection
+          CREATE_CARD = :create_card
+          JOIN_WHOP_UNIVERSITY = :join_whop_university
+          APPLY_FOR_FINANCING = :apply_for_financing
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Always optional — never blocking
+        #
+        # @see WhopSDK::Models::AccountRecommendActionsResponse::Data#status
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          OPTIONAL = :optional
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/account_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Accounts#retrieve
+    class AccountRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String]
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/account_social_link.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class AccountSocialLink < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the social link
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute title
+      #   The optional display title for the social link
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute url
+      #   The social link URL
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute website
+      #   The social platform for this link
+      #
+      #   @return [Symbol, WhopSDK::Models::AccountSocialLink::Website]
+      required :website, enum: -> { WhopSDK::AccountSocialLink::Website }
+
+      # @!method initialize(id:, title:, url:, website:)
+      #   @param id [String] The ID of the social link
+      #
+      #   @param title [String, nil] The optional display title for the social link
+      #
+      #   @param url [String] The social link URL
+      #
+      #   @param website [Symbol, WhopSDK::Models::AccountSocialLink::Website] The social platform for this link
+
+      # The social platform for this link
+      #
+      # @see WhopSDK::Models::AccountSocialLink#website
+      module Website
+        extend WhopSDK::Internal::Type::Enum
+
+        X = :x
+        INSTAGRAM = :instagram
+        FACEBOOK = :facebook
+        TIKTOK = :tiktok
+        YOUTUBE = :youtube
+        LINKEDIN = :linkedin
+        TWITCH = :twitch
+        WEBSITE = :website
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end