whop_sdk 0.0.2

data/lib/whop_sdk/models/currency.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The available currencies on the platform
+    module Currency
+      extend WhopSDK::Internal::Type::Enum
+
+      USD = :usd
+      SGD = :sgd
+      INR = :inr
+      AUD = :aud
+      BRL = :brl
+      CAD = :cad
+      DKK = :dkk
+      EUR = :eur
+      NOK = :nok
+      GBP = :gbp
+      SEK = :sek
+      CHF = :chf
+      HKD = :hkd
+      HUF = :huf
+      JPY = :jpy
+      MXN = :mxn
+      MYR = :myr
+      PLN = :pln
+      CZK = :czk
+      NZD = :nzd
+      AED = :aed
+      ETH = :eth
+      APE = :ape
+      COP = :cop
+      RON = :ron
+      THB = :thb
+      BGN = :bgn
+      IDR = :idr
+      DOP = :dop
+      PHP = :php
+      TRY = :try
+      KRW = :krw
+      TWD = :twd
+      VND = :vnd
+      PKR = :pkr
+      CLP = :clp
+      UYU = :uyu
+      ARS = :ars
+      ZAR = :zar
+      DZD = :dzd
+      TND = :tnd
+      MAD = :mad
+      KES = :kes
+      KWD = :kwd
+      JOD = :jod
+      ALL = :all
+      XCD = :xcd
+      AMD = :amd
+      BSD = :bsd
+      BHD = :bhd
+      BOB = :bob
+      BAM = :bam
+      KHR = :khr
+      CRC = :crc
+      XOF = :xof
+      EGP = :egp
+      ETB = :etb
+      GMD = :gmd
+      GHS = :ghs
+      GTQ = :gtq
+      GYD = :gyd
+      ILS = :ils
+      JMD = :jmd
+      MOP = :mop
+      MGA = :mga
+      MUR = :mur
+      MDL = :mdl
+      MNT = :mnt
+      NAD = :nad
+      NGN = :ngn
+      MKD = :mkd
+      OMR = :omr
+      PYG = :pyg
+      PEN = :pen
+      QAR = :qar
+      RWF = :rwf
+      SAR = :sar
+      RSD = :rsd
+      LKR = :lkr
+      TZS = :tzs
+      TTD = :ttd
+      UZS = :uzs
+      RUB = :rub
+      BTC = :btc
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/custom_cta.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different types of custom CTAs that can be selected.
+    module CustomCta
+      extend WhopSDK::Internal::Type::Enum
+
+      GET_ACCESS = :get_access
+      JOIN = :join
+      ORDER_NOW = :order_now
+      SHOP_NOW = :shop_now
+      CALL_NOW = :call_now
+      DONATE_NOW = :donate_now
+      CONTACT_US = :contact_us
+      SIGN_UP = :sign_up
+      SUBSCRIBE = :subscribe
+      PURCHASE = :purchase
+      GET_OFFER = :get_offer
+      APPLY_NOW = :apply_now
+      COMPLETE_ORDER = :complete_order
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/direction.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The direction of the sort.
+    module Direction
+      extend WhopSDK::Internal::Type::Enum
+
+      ASC = :asc
+      DESC = :desc
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/dms_post_types.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The types of post
+    module DmsPostTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      REGULAR = :regular
+      SYSTEM = :system
+      AUTOMATED = :automated
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/email_notification_preferences.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # Email notification preference option for a forum feed
+    module EmailNotificationPreferences
+      extend WhopSDK::Internal::Type::Enum
+
+      ALL_ADMIN_POSTS = :all_admin_posts
+      ONLY_WEEKLY_SUMMARY = :only_weekly_summary
+      NONE = :none
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/entry.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Entry < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the entry.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the entry was created.
+      #
+      #   @return [Time, nil]
+      required :created_at, Time, nil?: true
+
+      # @!attribute custom_field_responses
+      #   Responses collected from the user when submitting their entry.
+      #
+      #   @return [Array<WhopSDK::Models::Entry::CustomFieldResponse>, nil]
+      required :custom_field_responses,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Entry::CustomFieldResponse] },
+               nil?: true
+
+      # @!attribute plan
+      #   The waitlist plan the entry if for.
+      #
+      #   @return [WhopSDK::Models::Entry::Plan, nil]
+      required :plan, -> { WhopSDK::Entry::Plan }, nil?: true
+
+      # @!attribute product
+      #   The access pass tied to this entry, if there is one.
+      #
+      #   @return [WhopSDK::Models::Entry::Product, nil]
+      required :product, -> { WhopSDK::Entry::Product }, nil?: true
+
+      # @!attribute status
+      #   The status of the entry.
+      #
+      #   @return [Symbol, WhopSDK::Models::EntryStatus]
+      required :status, enum: -> { WhopSDK::EntryStatus }
+
+      # @!attribute user
+      #   The user who created the entry.
+      #
+      #   @return [WhopSDK::Models::Entry::User]
+      required :user, -> { WhopSDK::Entry::User }
+
+      # @!method initialize(id:, created_at:, custom_field_responses:, plan:, product:, status:, user:)
+      #   An object representing an entry in a waitlist.
+      #
+      #   @param id [String] The internal ID of the entry.
+      #
+      #   @param created_at [Time, nil] When the entry was created.
+      #
+      #   @param custom_field_responses [Array<WhopSDK::Models::Entry::CustomFieldResponse>, nil] Responses collected from the user when submitting their entry.
+      #
+      #   @param plan [WhopSDK::Models::Entry::Plan, nil] The waitlist plan the entry if for.
+      #
+      #   @param product [WhopSDK::Models::Entry::Product, nil] The access pass tied to this entry, if there is one.
+      #
+      #   @param status [Symbol, WhopSDK::Models::EntryStatus] The status of the entry.
+      #
+      #   @param user [WhopSDK::Models::Entry::User] The user who created the entry.
+
+      class CustomFieldResponse < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the custom field item
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute answer
+        #   The response a user gave to the specific question or field.
+        #
+        #   @return [String]
+        required :answer, String
+
+        # @!attribute question
+        #   The question asked by the custom field
+        #
+        #   @return [String]
+        required :question, String
+
+        # @!method initialize(id:, answer:, question:)
+        #   The response from a custom field on checkout
+        #
+        #   @param id [String] The ID of the custom field item
+        #
+        #   @param answer [String] The response a user gave to the specific question or field.
+        #
+        #   @param question [String] The question asked by the custom field
+      end
+
+      # @see WhopSDK::Models::Entry#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The waitlist plan the entry if for.
+        #
+        #   @param id [String] The internal ID of the plan.
+      end
+
+      # @see WhopSDK::Models::Entry#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The access pass tied to this entry, if there is one.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+
+      # @see WhopSDK::Models::Entry#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!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:, email:, name:, username:)
+        #   The user who created the entry.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email 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
+    end
+  end
+end

data/lib/whop_sdk/models/entry_approve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#approve
+    class EntryApproveParams < 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/entry_approve_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#approve
+    class EntryApproveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute job_id
+      #   The ID of the job.
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!method initialize(job_id:)
+      #   An object representing an asynchronous job.
+      #
+      #   @param job_id [String] The ID of the job.
+    end
+  end
+end

data/lib/whop_sdk/models/entry_approved_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class EntryApprovedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing an entry in a waitlist.
+      #
+      #   @return [WhopSDK::Models::Entry]
+      required :data, -> { WhopSDK::Entry }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"entry.approved"]
+      required :type, const: :"entry.approved"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"entry.approved")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Entry] An object representing an entry in a waitlist.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"entry.approved"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/entry_created_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class EntryCreatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing an entry in a waitlist.
+      #
+      #   @return [WhopSDK::Models::Entry]
+      required :data, -> { WhopSDK::Entry }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"entry.created"]
+      required :type, const: :"entry.created"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"entry.created")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Entry] An object representing an entry in a waitlist.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"entry.created"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/entry_deleted_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class EntryDeletedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing an entry in a waitlist.
+      #
+      #   @return [WhopSDK::Models::Entry]
+      required :data, -> { WhopSDK::Entry }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"entry.deleted"]
+      required :type, const: :"entry.deleted"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"entry.deleted")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Entry] An object representing an entry in a waitlist.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"entry.deleted"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/entry_denied_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class EntryDeniedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing an entry in a waitlist.
+      #
+      #   @return [WhopSDK::Models::Entry]
+      required :data, -> { WhopSDK::Entry }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"entry.denied"]
+      required :type, const: :"entry.denied"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"entry.denied")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Entry] An object representing an entry in a waitlist.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"entry.denied"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/entry_deny_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#deny
+    class EntryDenyParams < 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/entry_list_params.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Entries#list
+    class EntryListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company
+      #
+      #   @return [String]
+      required :company_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 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
+      #   Which columns can be used to sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::EntryListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::EntryListParams::Order }, nil?: true
+
+      # @!attribute plan_ids
+      #   The plan IDs to filter the entries by
+      #
+      #   @return [Array<String>, nil]
+      optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute product_ids
+      #   The product IDs to filter the entries by
+      #
+      #   @return [Array<String>, nil]
+      optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute statuses
+      #   The statuses to filter the entries by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::EntryStatus>, nil]
+      optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::EntryStatus] }, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
+      #   @param company_id [String] The ID of the company
+      #
+      #   @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 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::EntryListParams::Order, nil] Which columns can be used to sort.
+      #
+      #   @param plan_ids [Array<String>, nil] The plan IDs to filter the entries by
+      #
+      #   @param product_ids [Array<String>, nil] The product IDs to filter the entries by
+      #
+      #   @param statuses [Array<Symbol, WhopSDK::Models::EntryStatus>, nil] The statuses to filter the entries by
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Which columns can be used to sort.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        ID = :id
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end