whop_sdk 0.0.2

data/lib/whop_sdk/models/membership.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Membership < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the membership
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cancel_at_period_end
+      #   Whether this Membership is set to cancel at the end of the current billing
+      #   cycle. Only applies for memberships that have a renewal plan.
+      #
+      #   @return [Boolean]
+      required :cancel_at_period_end, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute canceled_at
+      #   The epoch timestamp of when the customer initiated a cancellation.
+      #
+      #   @return [Time, nil]
+      required :canceled_at, Time, nil?: true
+
+      # @!attribute cancellation_reason
+      #   The reason that the member canceled the membership (filled out by the member).
+      #
+      #   @return [String, nil]
+      required :cancellation_reason, String, nil?: true
+
+      # @!attribute company
+      #   The Company this Membership belongs to.
+      #
+      #   @return [WhopSDK::Models::Membership::Company]
+      required :company, -> { WhopSDK::Membership::Company }
+
+      # @!attribute created_at
+      #   The timestamp, in seconds, that this Membership was created at.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      required :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute license_key
+      #   The license key for this Membership. This is only present if the membership
+      #   grants access to an instance of the Whop Software app.
+      #
+      #   @return [String, nil]
+      required :license_key, String, nil?: true
+
+      # @!attribute manage_url
+      #   The URL for the customer to manage their membership.
+      #
+      #   @return [String, nil]
+      required :manage_url, String, nil?: true
+
+      # @!attribute member
+      #   The Member that this Membership belongs to.
+      #
+      #   @return [WhopSDK::Models::Membership::Member, nil]
+      required :member, -> { WhopSDK::Membership::Member }, nil?: true
+
+      # @!attribute metadata
+      #   A JSON object used to store software licensing information. Ex. HWID
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
+
+      # @!attribute payment_collection_paused
+      #   Whether the membership's payments are currently paused.
+      #
+      #   @return [Boolean]
+      required :payment_collection_paused, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute plan
+      #   The Plan this Membership is for.
+      #
+      #   @return [WhopSDK::Models::Membership::Plan]
+      required :plan, -> { WhopSDK::Membership::Plan }
+
+      # @!attribute promo_code
+      #   The Promo Code that is currently applied to this Membership.
+      #
+      #   @return [WhopSDK::Models::Membership::PromoCode, nil]
+      required :promo_code, -> { WhopSDK::Membership::PromoCode }, nil?: true
+
+      # @!attribute renewal_period_end
+      #   The timestamp in seconds at which the current billing cycle for this
+      #   subscription ends. Only applies for memberships that have a renewal plan.
+      #
+      #   @return [Time, nil]
+      required :renewal_period_end, Time, nil?: true
+
+      # @!attribute renewal_period_start
+      #   The timestamp in seconds at which the current billing cycle for this
+      #   subscription start. Only applies for memberships that have a renewal plan.
+      #
+      #   @return [Time, nil]
+      required :renewal_period_start, Time, nil?: true
+
+      # @!attribute status
+      #   The status of the membership.
+      #
+      #   @return [Symbol, WhopSDK::Models::MembershipStatus]
+      required :status, enum: -> { WhopSDK::MembershipStatus }
+
+      # @!attribute updated_at
+      #   A timestamp of when the membership was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user this membership belongs to
+      #
+      #   @return [WhopSDK::Models::Membership::User, nil]
+      required :user, -> { WhopSDK::Membership::User }, nil?: true
+
+      # @!method initialize(id:, cancel_at_period_end:, canceled_at:, cancellation_reason:, company:, created_at:, currency:, license_key:, manage_url:, member:, metadata:, payment_collection_paused:, plan:, promo_code:, renewal_period_end:, renewal_period_start:, status:, updated_at:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::Membership} for more details.
+      #
+      #   A membership represents a purchase between a User and a Company for a specific
+      #   Product.
+      #
+      #   @param id [String] The ID of the membership
+      #
+      #   @param cancel_at_period_end [Boolean] Whether this Membership is set to cancel at the end of the current billing cycle
+      #
+      #   @param canceled_at [Time, nil] The epoch timestamp of when the customer initiated a cancellation.
+      #
+      #   @param cancellation_reason [String, nil] The reason that the member canceled the membership (filled out by the member).
+      #
+      #   @param company [WhopSDK::Models::Membership::Company] The Company this Membership belongs to.
+      #
+      #   @param created_at [Time] The timestamp, in seconds, that this Membership was created at.
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      #   @param license_key [String, nil] The license key for this Membership. This is only present if the membership gran
+      #
+      #   @param manage_url [String, nil] The URL for the customer to manage their membership.
+      #
+      #   @param member [WhopSDK::Models::Membership::Member, nil] The Member that this Membership belongs to.
+      #
+      #   @param metadata [Hash{Symbol=>Object}] A JSON object used to store software licensing information. Ex. HWID
+      #
+      #   @param payment_collection_paused [Boolean] Whether the membership's payments are currently paused.
+      #
+      #   @param plan [WhopSDK::Models::Membership::Plan] The Plan this Membership is for.
+      #
+      #   @param promo_code [WhopSDK::Models::Membership::PromoCode, nil] The Promo Code that is currently applied to this Membership.
+      #
+      #   @param renewal_period_end [Time, nil] The timestamp in seconds at which the current billing cycle for this subscriptio
+      #
+      #   @param renewal_period_start [Time, nil] The timestamp in seconds at which the current billing cycle for this subscriptio
+      #
+      #   @param status [Symbol, WhopSDK::Models::MembershipStatus] The status of the membership.
+      #
+      #   @param updated_at [Time] A timestamp of when the membership was last updated
+      #
+      #   @param user [WhopSDK::Models::Membership::User, nil] The user this membership belongs to
+
+      # @see WhopSDK::Models::Membership#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 this Membership belongs to.
+        #
+        #   @param id [String] The ID (tag) of the company.
+        #
+        #   @param title [String] The title of the company.
+      end
+
+      # @see WhopSDK::Models::Membership#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The Member that this Membership belongs to.
+        #
+        #   @param id [String] The ID of the member
+      end
+
+      # @see WhopSDK::Models::Membership#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The Plan this Membership is for.
+        #
+        #   @param id [String] The internal ID of the plan.
+      end
+
+      # @see WhopSDK::Models::Membership#promo_code
+      class PromoCode < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the promo.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The Promo Code that is currently applied to this Membership.
+        #
+        #   @param id [String] The ID of the promo.
+      end
+
+      # @see WhopSDK::Models::Membership#user
+      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 username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user this membership belongs to
+        #
+        #   @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
+    end
+  end
+end

data/lib/whop_sdk/models/membership_activated_webhook_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class MembershipActivatedWebhookEvent < 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
+      #   A membership represents a purchase between a User and a Company for a specific
+      #   Product.
+      #
+      #   @return [WhopSDK::Models::Membership]
+      required :data, -> { WhopSDK::Membership }
+
+      # @!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, :"membership.activated"]
+      required :type, const: :"membership.activated"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"membership.activated")
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::MembershipActivatedWebhookEvent} for more details.
+      #
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Membership] A membership represents a purchase between a User and a Company for a specific P
+      #
+      #   @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, :"membership.activated"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/membership_cancel_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Memberships#cancel
+    class MembershipCancelParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute cancellation_mode
+      #   The mode of cancellation for a membership
+      #
+      #   @return [Symbol, WhopSDK::Models::MembershipCancelParams::CancellationMode, nil]
+      optional :cancellation_mode, enum: -> { WhopSDK::MembershipCancelParams::CancellationMode }, nil?: true
+
+      # @!method initialize(cancellation_mode: nil, request_options: {})
+      #   @param cancellation_mode [Symbol, WhopSDK::Models::MembershipCancelParams::CancellationMode, nil] The mode of cancellation for a membership
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The mode of cancellation for a membership
+      module CancellationMode
+        extend WhopSDK::Internal::Type::Enum
+
+        AT_PERIOD_END = :at_period_end
+        IMMEDIATE = :immediate
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/membership_deactivated_webhook_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class MembershipDeactivatedWebhookEvent < 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
+      #   A membership represents a purchase between a User and a Company for a specific
+      #   Product.
+      #
+      #   @return [WhopSDK::Models::Membership]
+      required :data, -> { WhopSDK::Membership }
+
+      # @!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, :"membership.deactivated"]
+      required :type, const: :"membership.deactivated"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"membership.deactivated")
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::MembershipDeactivatedWebhookEvent} for more details.
+      #
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Membership] A membership represents a purchase between a User and a Company for a specific P
+      #
+      #   @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, :"membership.deactivated"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/membership_list_params.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Memberships#list
+    class MembershipListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list memberships for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute access_pass_ids
+      #   The access pass IDs to filter the memberships by
+      #
+      #   @return [Array<String>, nil]
+      optional :access_pass_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!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 cancel_options
+      #   The cancel options to filter the memberships by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil]
+      optional :cancel_options,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MembershipListParams::CancelOption] },
+               nil?: true
+
+      # @!attribute created_after
+      #   The minimum creation date to filter by
+      #
+      #   @return [Time, nil]
+      optional :created_after, Time, nil?: true
+
+      # @!attribute created_before
+      #   The maximum creation date to filter by
+      #
+      #   @return [Time, nil]
+      optional :created_before, Time, 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::MembershipListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::MembershipListParams::Order }, nil?: true
+
+      # @!attribute plan_ids
+      #   The plan IDs to filter the memberships by
+      #
+      #   @return [Array<String>, nil]
+      optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute promo_code_ids
+      #   The promo code IDs to filter the memberships by
+      #
+      #   @return [Array<String>, nil]
+      optional :promo_code_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute statuses
+      #   The membership status to filter the memberships by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil]
+      optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MembershipStatus] }, nil?: true
+
+      # @!method initialize(company_id:, access_pass_ids: nil, after: nil, before: nil, cancel_options: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, promo_code_ids: nil, statuses: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to list memberships for
+      #
+      #   @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the memberships 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 cancel_options [Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil] The cancel options to filter the memberships by
+      #
+      #   @param created_after [Time, nil] The minimum creation date to filter by
+      #
+      #   @param created_before [Time, nil] The maximum creation date to filter 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::MembershipListParams::Order, nil] Which columns can be used to sort.
+      #
+      #   @param plan_ids [Array<String>, nil] The plan IDs to filter the memberships by
+      #
+      #   @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the memberships by
+      #
+      #   @param statuses [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil] The membership status to filter the memberships by
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The different reasons a user can choose for why they are canceling their
+      # membership.
+      module CancelOption
+        extend WhopSDK::Internal::Type::Enum
+
+        TOO_EXPENSIVE = :too_expensive
+        SWITCHING = :switching
+        MISSING_FEATURES = :missing_features
+        TECHNICAL_ISSUES = :technical_issues
+        BAD_EXPERIENCE = :bad_experience
+        OTHER = :other
+        TESTING = :testing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Which columns can be used to sort.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        ID = :id
+        CREATED_AT = :created_at
+        STATUS = :status
+        CANCELED_AT = :canceled_at
+        DATE_JOINED = :date_joined
+        TOTAL_SPEND = :total_spend
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end