whop_sdk 0.0.2

data/lib/whop_sdk/models/transfer.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Transfer < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the credit transaction transfer
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The amount of the credit transaction transfer
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   The timestamp when the credit transaction transfer was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the credit transaction transfer
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute destination
+      #   The recipient of the credit transaction transfer
+      #
+      #   @return [WhopSDK::Models::Transfer::Destination::User, WhopSDK::Models::Transfer::Destination::Company, nil]
+      required :destination, union: -> { WhopSDK::Transfer::Destination }
+
+      # @!attribute destination_ledger_account_id
+      #   The ID of the destination ledger account
+      #
+      #   @return [String]
+      required :destination_ledger_account_id, String
+
+      # @!attribute fee_amount
+      #   The decimal fee of the credit transaction transfer
+      #
+      #   @return [Float, nil]
+      required :fee_amount, Float, nil?: true
+
+      # @!attribute notes
+      #   The notes of the credit transaction transfer
+      #
+      #   @return [String, nil]
+      required :notes, String, nil?: true
+
+      # @!attribute origin
+      #   The sender of the credit transaction transfer
+      #
+      #   @return [WhopSDK::Models::Transfer::Origin::User, WhopSDK::Models::Transfer::Origin::Company, nil]
+      required :origin, union: -> { WhopSDK::Transfer::Origin }
+
+      # @!attribute origin_ledger_account_id
+      #   The ID of the origin ledger account
+      #
+      #   @return [String]
+      required :origin_ledger_account_id, String
+
+      # @!method initialize(id:, amount:, created_at:, currency:, destination:, destination_ledger_account_id:, fee_amount:, notes:, origin:, origin_ledger_account_id:)
+      #   Credit Transaction Transfer
+      #
+      #   @param id [String] The unique identifier of the credit transaction transfer
+      #
+      #   @param amount [Float] The amount of the credit transaction transfer
+      #
+      #   @param created_at [Time] The timestamp when the credit transaction transfer was created
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The currency of the credit transaction transfer
+      #
+      #   @param destination [WhopSDK::Models::Transfer::Destination::User, WhopSDK::Models::Transfer::Destination::Company, nil] The recipient of the credit transaction transfer
+      #
+      #   @param destination_ledger_account_id [String] The ID of the destination ledger account
+      #
+      #   @param fee_amount [Float, nil] The decimal fee of the credit transaction transfer
+      #
+      #   @param notes [String, nil] The notes of the credit transaction transfer
+      #
+      #   @param origin [WhopSDK::Models::Transfer::Origin::User, WhopSDK::Models::Transfer::Origin::Company, nil] The sender of the credit transaction transfer
+      #
+      #   @param origin_ledger_account_id [String] The ID of the origin ledger account
+
+      # The recipient of the credit transaction transfer
+      #
+      # @see WhopSDK::Models::Transfer#destination
+      module Destination
+        extend WhopSDK::Internal::Type::Union
+
+        discriminator :typename
+
+        # An object representing a (sanitized) user of the site.
+        variant :User, -> { WhopSDK::Transfer::Destination::User }
+
+        # An object representing a (sanitized) company.
+        variant :Company, -> { WhopSDK::Transfer::Destination::Company }
+
+        class User < 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 typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :User]
+          required :typename, const: :User
+
+          # @!attribute username
+          #   The username of the user from their Whop account.
+          #
+          #   @return [String]
+          required :username, String
+
+          # @!method initialize(id:, name:, username:, typename: :User)
+          #   An object representing a (sanitized) user of the site.
+          #
+          #   @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.
+          #
+          #   @param typename [Symbol, :User] The typename of this object
+        end
+
+        class Company < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID (tag) of the company.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute route
+          #   The slug/route of the company on the Whop site.
+          #
+          #   @return [String]
+          required :route, String
+
+          # @!attribute title
+          #   The title of the company.
+          #
+          #   @return [String]
+          required :title, String
+
+          # @!attribute typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :Company]
+          required :typename, const: :Company
+
+          # @!method initialize(id:, route:, title:, typename: :Company)
+          #   An object representing a (sanitized) company.
+          #
+          #   @param id [String] The ID (tag) of the company.
+          #
+          #   @param route [String] The slug/route of the company on the Whop site.
+          #
+          #   @param title [String] The title of the company.
+          #
+          #   @param typename [Symbol, :Company] The typename of this object
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::Transfer::Destination::User, WhopSDK::Models::Transfer::Destination::Company)]
+      end
+
+      # The sender of the credit transaction transfer
+      #
+      # @see WhopSDK::Models::Transfer#origin
+      module Origin
+        extend WhopSDK::Internal::Type::Union
+
+        discriminator :typename
+
+        # An object representing a (sanitized) user of the site.
+        variant :User, -> { WhopSDK::Transfer::Origin::User }
+
+        # An object representing a (sanitized) company.
+        variant :Company, -> { WhopSDK::Transfer::Origin::Company }
+
+        class User < 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 typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :User]
+          required :typename, const: :User
+
+          # @!attribute username
+          #   The username of the user from their Whop account.
+          #
+          #   @return [String]
+          required :username, String
+
+          # @!method initialize(id:, name:, username:, typename: :User)
+          #   An object representing a (sanitized) user of the site.
+          #
+          #   @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.
+          #
+          #   @param typename [Symbol, :User] The typename of this object
+        end
+
+        class Company < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID (tag) of the company.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute route
+          #   The slug/route of the company on the Whop site.
+          #
+          #   @return [String]
+          required :route, String
+
+          # @!attribute title
+          #   The title of the company.
+          #
+          #   @return [String]
+          required :title, String
+
+          # @!attribute typename
+          #   The typename of this object
+          #
+          #   @return [Symbol, :Company]
+          required :typename, const: :Company
+
+          # @!method initialize(id:, route:, title:, typename: :Company)
+          #   An object representing a (sanitized) company.
+          #
+          #   @param id [String] The ID (tag) of the company.
+          #
+          #   @param route [String] The slug/route of the company on the Whop site.
+          #
+          #   @param title [String] The title of the company.
+          #
+          #   @param typename [Symbol, :Company] The typename of this object
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::Transfer::Origin::User, WhopSDK::Models::Transfer::Origin::Company)]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/transfer_create_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Transfers#create
+    class TransferCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   The amount to withdraw
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute currency
+      #   The currency that is being withdrawn.
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute destination_id
+      #   The ID of the destination account which will receive the funds (either a User
+      #   ID, Company ID, or LedgerAccount ID)
+      #
+      #   @return [String]
+      required :destination_id, String
+
+      # @!attribute origin_id
+      #   The ID of the origin account which will send the funds (either a User ID,
+      #   Company ID, or LedgerAccount ID)
+      #
+      #   @return [String]
+      required :origin_id, String
+
+      # @!attribute idempotence_key
+      #   A unique key to ensure idempotence. Use a UUID or similar.
+      #
+      #   @return [String, nil]
+      optional :idempotence_key, String, nil?: true
+
+      # @!attribute notes
+      #   Notes for the transfer. Maximum of 50 characters.
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!method initialize(amount:, currency:, destination_id:, origin_id:, idempotence_key: nil, notes: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::TransferCreateParams} for more details.
+      #
+      #   @param amount [Float] The amount to withdraw
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The currency that is being withdrawn.
+      #
+      #   @param destination_id [String] The ID of the destination account which will receive the funds (either a User ID
+      #
+      #   @param origin_id [String] The ID of the origin account which will send the funds (either a User ID, Compan
+      #
+      #   @param idempotence_key [String, nil] A unique key to ensure idempotence. Use a UUID or similar.
+      #
+      #   @param notes [String, nil] Notes for the transfer. Maximum of 50 characters.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/transfer_list_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Transfers#list
+    class TransferListParams < 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 destination_id
+      #   Filter transfers to only those that were sent to this destination account.
+      #   (user_xxx, biz_xxx, ldgr_xxx)
+      #
+      #   @return [String, nil]
+      optional :destination_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
+      #   Which columns can be used to sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::TransferListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::TransferListParams::Order }, nil?: true
+
+      # @!attribute origin_id
+      #   Filter transfers to only those that were sent from this origin account.
+      #   (user_xxx, biz_xxx, ldgr_xxx)
+      #
+      #   @return [String, nil]
+      optional :origin_id, String, nil?: true
+
+      # @!method initialize(after: nil, before: nil, destination_id: nil, direction: nil, first: nil, last: nil, order: nil, origin_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::TransferListParams} 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 destination_id [String, nil] Filter transfers to only those that were sent to this destination account. (user
+      #
+      #   @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::TransferListParams::Order, nil] Which columns can be used to sort.
+      #
+      #   @param origin_id [String, nil] Filter transfers to only those that were sent from this origin account. (user_xx
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Which columns can be used to sort.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        AMOUNT = :amount
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/transfer_list_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Transfers#list
+    class TransferListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the credit transaction transfer
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The amount of the credit transaction transfer
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   The timestamp when the credit transaction transfer was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the credit transaction transfer
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute destination_ledger_account_id
+      #   The ID of the destination ledger account
+      #
+      #   @return [String]
+      required :destination_ledger_account_id, String
+
+      # @!attribute fee_amount
+      #   The decimal fee of the credit transaction transfer
+      #
+      #   @return [Float, nil]
+      required :fee_amount, Float, nil?: true
+
+      # @!attribute notes
+      #   The notes of the credit transaction transfer
+      #
+      #   @return [String, nil]
+      required :notes, String, nil?: true
+
+      # @!attribute origin_ledger_account_id
+      #   The ID of the origin ledger account
+      #
+      #   @return [String]
+      required :origin_ledger_account_id, String
+
+      # @!method initialize(id:, amount:, created_at:, currency:, destination_ledger_account_id:, fee_amount:, notes:, origin_ledger_account_id:)
+      #   Credit Transaction Transfer
+      #
+      #   @param id [String] The unique identifier of the credit transaction transfer
+      #
+      #   @param amount [Float] The amount of the credit transaction transfer
+      #
+      #   @param created_at [Time] The timestamp when the credit transaction transfer was created
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The currency of the credit transaction transfer
+      #
+      #   @param destination_ledger_account_id [String] The ID of the destination ledger account
+      #
+      #   @param fee_amount [Float, nil] The decimal fee of the credit transaction transfer
+      #
+      #   @param notes [String, nil] The notes of the credit transaction transfer
+      #
+      #   @param origin_ledger_account_id [String] The ID of the origin ledger account
+    end
+  end
+end

data/lib/whop_sdk/models/transfer_retrieve_params.rb

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module UnwrapWebhookEvent
+      extend WhopSDK::Internal::Type::Union
+
+      variant -> { WhopSDK::InvoiceCreatedWebhookEvent }
+
+      variant -> { WhopSDK::InvoicePaidWebhookEvent }
+
+      variant -> { WhopSDK::InvoicePastDueWebhookEvent }
+
+      variant -> { WhopSDK::InvoiceVoidedWebhookEvent }
+
+      variant -> { WhopSDK::MembershipActivatedWebhookEvent }
+
+      variant -> { WhopSDK::MembershipDeactivatedWebhookEvent }
+
+      variant -> { WhopSDK::EntryCreatedWebhookEvent }
+
+      variant -> { WhopSDK::EntryApprovedWebhookEvent }
+
+      variant -> { WhopSDK::EntryDeniedWebhookEvent }
+
+      variant -> { WhopSDK::EntryDeletedWebhookEvent }
+
+      variant -> { WhopSDK::CourseLessonInteractionCompletedWebhookEvent }
+
+      variant -> { WhopSDK::PaymentSucceededWebhookEvent }
+
+      variant -> { WhopSDK::PaymentFailedWebhookEvent }
+
+      variant -> { WhopSDK::PaymentPendingWebhookEvent }
+
+      # @!method self.variants
+      #   @return [Array(WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent)]
+    end
+  end
+end

data/lib/whop_sdk/models/user_check_access_params.rb

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

data/lib/whop_sdk/models/user_check_access_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Users#check_access
+    class UserCheckAccessResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute access_level
+      #   The permission level of the user
+      #
+      #   @return [Symbol, WhopSDK::Models::AccessLevel]
+      required :access_level, enum: -> { WhopSDK::AccessLevel }
+
+      # @!attribute has_access
+      #   Whether the user has access to the resource
+      #
+      #   @return [Boolean]
+      required :has_access, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(access_level:, has_access:)
+      #   The result of a has access check for the developer API
+      #
+      #   @param access_level [Symbol, WhopSDK::Models::AccessLevel] The permission level of the user
+      #
+      #   @param has_access [Boolean] Whether the user has access to the resource
+    end
+  end
+end

data/lib/whop_sdk/models/user_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Users#retrieve
+    class UserRetrieveParams < 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