whop_sdk 0.0.2

data/lib/whop_sdk/models/member_list_params.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Members#list
+    class MemberListParams < 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 members for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute access_level
+      #   The access level a given user (or company) has to an access pass or company.
+      #
+      #   @return [Symbol, WhopSDK::Models::AccessLevel, nil]
+      optional :access_level, enum: -> { WhopSDK::AccessLevel }, nil?: true
+
+      # @!attribute access_pass_ids
+      #   The access pass IDs to filter the members 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 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 most_recent_actions
+      #   The most recent actions to filter the members by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::MemberMostRecentActions>, nil]
+      optional :most_recent_actions,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MemberMostRecentActions] },
+               nil?: true
+
+      # @!attribute order
+      #   Which columns can be used to sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::MemberListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::MemberListParams::Order }, nil?: true
+
+      # @!attribute plan_ids
+      #   The plan IDs to filter the members 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 members by
+      #
+      #   @return [Array<String>, nil]
+      optional :promo_code_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute query
+      #   The name, username, or email to filter the members by. The email filter will
+      #   only apply if the current actor has the `member:email:read` permission.
+      #
+      #   @return [String, nil]
+      optional :query, String, nil?: true
+
+      # @!attribute statuses
+      #   The statuses to filter the members by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::MemberStatuses>, nil]
+      optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MemberStatuses] }, nil?: true
+
+      # @!method initialize(company_id:, access_level: nil, access_pass_ids: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, most_recent_actions: nil, order: nil, plan_ids: nil, promo_code_ids: nil, query: nil, statuses: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::MemberListParams} for more details.
+      #
+      #   @param company_id [String] The ID of the company to list members for
+      #
+      #   @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to an access pass or company.
+      #
+      #   @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the members 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 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 most_recent_actions [Array<Symbol, WhopSDK::Models::MemberMostRecentActions>, nil] The most recent actions to filter the members by
+      #
+      #   @param order [Symbol, WhopSDK::Models::MemberListParams::Order, nil] Which columns can be used to sort.
+      #
+      #   @param plan_ids [Array<String>, nil] The plan IDs to filter the members by
+      #
+      #   @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the members by
+      #
+      #   @param query [String, nil] The name, username, or email to filter the members by. The email filter will onl
+      #
+      #   @param statuses [Array<Symbol, WhopSDK::Models::MemberStatuses>, nil] The statuses to filter the members 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
+        USD_TOTAL_SPENT = :usd_total_spent
+        CREATED_AT = :created_at
+        JOINED_AT = :joined_at
+        MOST_RECENT_ACTION = :most_recent_action
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/member_list_response.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Members#list
+    class MemberListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the member
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute access_level
+      #   The access level of the product member. If its admin, the member is an
+      #   authorized user of the access pass. If its customer, the member has a valid
+      #   membership to the access pass. If its no_access, the member does not have access
+      #   to the access pass.
+      #
+      #   @return [Symbol, WhopSDK::Models::AccessLevel]
+      required :access_level, enum: -> { WhopSDK::AccessLevel }
+
+      # @!attribute created_at
+      #   When the member was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute joined_at
+      #   When the member joined the company
+      #
+      #   @return [Time]
+      required :joined_at, Time
+
+      # @!attribute most_recent_action
+      #   The different most recent actions a member can have.
+      #
+      #   @return [Symbol, WhopSDK::Models::MemberMostRecentActions, nil]
+      required :most_recent_action, enum: -> { WhopSDK::MemberMostRecentActions }, nil?: true
+
+      # @!attribute most_recent_action_at
+      #   The time for the most recent action, if applicable.
+      #
+      #   @return [Time, nil]
+      required :most_recent_action_at, Time, nil?: true
+
+      # @!attribute phone
+      #   The phone number for the member, if available.
+      #
+      #   @return [String, nil]
+      required :phone, String, nil?: true
+
+      # @!attribute status
+      #   The status of the member
+      #
+      #   @return [Symbol, WhopSDK::Models::MemberStatuses]
+      required :status, enum: -> { WhopSDK::MemberStatuses }
+
+      # @!attribute updated_at
+      #   The timestamp of when this member was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute usd_total_spent
+      #   How much money this customer has spent on the company's products and plans
+      #
+      #   @return [Float]
+      required :usd_total_spent, Float
+
+      # @!attribute user
+      #   The user for this member, if any.
+      #
+      #   @return [WhopSDK::Models::MemberListResponse::User, nil]
+      required :user, -> { WhopSDK::Models::MemberListResponse::User }, nil?: true
+
+      # @!method initialize(id:, access_level:, created_at:, joined_at:, most_recent_action:, most_recent_action_at:, phone:, status:, updated_at:, usd_total_spent:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::MemberListResponse} for more details.
+      #
+      #   An object representing a connection between a creator and a user/company_buyer.
+      #   This type should only be made visible to the user/company_buyer who is a part of
+      #   the connection.
+      #
+      #   @param id [String] The ID of the member
+      #
+      #   @param access_level [Symbol, WhopSDK::Models::AccessLevel] The access level of the product member. If its admin, the member is an authorize
+      #
+      #   @param created_at [Time] When the member was created
+      #
+      #   @param joined_at [Time] When the member joined the company
+      #
+      #   @param most_recent_action [Symbol, WhopSDK::Models::MemberMostRecentActions, nil] The different most recent actions a member can have.
+      #
+      #   @param most_recent_action_at [Time, nil] The time for the most recent action, if applicable.
+      #
+      #   @param phone [String, nil] The phone number for the member, if available.
+      #
+      #   @param status [Symbol, WhopSDK::Models::MemberStatuses] The status of the member
+      #
+      #   @param updated_at [Time] The timestamp of when this member was last updated
+      #
+      #   @param usd_total_spent [Float] How much money this customer has spent on the company's products and plans
+      #
+      #   @param user [WhopSDK::Models::MemberListResponse::User, nil] The user for this member, if any.
+
+      # @see WhopSDK::Models::MemberListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user account.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The digital mailing address of the user.
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute name
+        #   The user's full name.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The whop username.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, email:, name:, username:)
+        #   The user for this member, if any.
+        #
+        #   @param id [String] The internal ID of the user account.
+        #
+        #   @param email [String, nil] The digital mailing address of the user.
+        #
+        #   @param name [String, nil] The user's full name.
+        #
+        #   @param username [String] The whop username.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/member_most_recent_actions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different most recent actions a member can have.
+    module MemberMostRecentActions
+      extend WhopSDK::Internal::Type::Enum
+
+      CANCELING = :canceling
+      CHURNED = :churned
+      FINISHED_SPLIT_PAY = :finished_split_pay
+      PAUSED = :paused
+      PAID_SUBSCRIBER = :paid_subscriber
+      PAID_ONCE = :paid_once
+      EXPIRING = :expiring
+      JOINED = :joined
+      DRAFTED = :drafted
+      LEFT = :left
+      TRIALING = :trialing
+      PENDING_ENTRY = :pending_entry
+      RENEWING = :renewing
+      PAST_DUE = :past_due
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/member_retrieve_params.rb

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Members#retrieve
+    class MemberRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the member
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute access_level
+      #   The access level of the product member. If its admin, the member is an
+      #   authorized user of the access pass. If its customer, the member has a valid
+      #   membership to the access pass. If its no_access, the member does not have access
+      #   to the access pass.
+      #
+      #   @return [Symbol, WhopSDK::Models::AccessLevel]
+      required :access_level, enum: -> { WhopSDK::AccessLevel }
+
+      # @!attribute company
+      #   The company for the member.
+      #
+      #   @return [WhopSDK::Models::MemberRetrieveResponse::Company]
+      required :company, -> { WhopSDK::Models::MemberRetrieveResponse::Company }
+
+      # @!attribute created_at
+      #   When the member was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute joined_at
+      #   When the member joined the company
+      #
+      #   @return [Time]
+      required :joined_at, Time
+
+      # @!attribute most_recent_action
+      #   The different most recent actions a member can have.
+      #
+      #   @return [Symbol, WhopSDK::Models::MemberMostRecentActions, nil]
+      required :most_recent_action, enum: -> { WhopSDK::MemberMostRecentActions }, nil?: true
+
+      # @!attribute most_recent_action_at
+      #   The time for the most recent action, if applicable.
+      #
+      #   @return [Time, nil]
+      required :most_recent_action_at, Time, nil?: true
+
+      # @!attribute phone
+      #   The phone number for the member, if available.
+      #
+      #   @return [String, nil]
+      required :phone, String, nil?: true
+
+      # @!attribute status
+      #   The status of the member
+      #
+      #   @return [Symbol, WhopSDK::Models::MemberStatuses]
+      required :status, enum: -> { WhopSDK::MemberStatuses }
+
+      # @!attribute updated_at
+      #   The timestamp of when this member was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute usd_total_spent
+      #   How much money this customer has spent on the company's products and plans
+      #
+      #   @return [Float]
+      required :usd_total_spent, Float
+
+      # @!attribute user
+      #   The user for this member, if any.
+      #
+      #   @return [WhopSDK::Models::MemberRetrieveResponse::User, nil]
+      required :user, -> { WhopSDK::Models::MemberRetrieveResponse::User }, nil?: true
+
+      # @!method initialize(id:, access_level:, company:, created_at:, joined_at:, most_recent_action:, most_recent_action_at:, phone:, status:, updated_at:, usd_total_spent:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::MemberRetrieveResponse} for more details.
+      #
+      #   An object representing a connection between a creator and a user/company_buyer.
+      #   This type should only be made visible to the user/company_buyer who is a part of
+      #   the connection.
+      #
+      #   @param id [String] The ID of the member
+      #
+      #   @param access_level [Symbol, WhopSDK::Models::AccessLevel] The access level of the product member. If its admin, the member is an authorize
+      #
+      #   @param company [WhopSDK::Models::MemberRetrieveResponse::Company] The company for the member.
+      #
+      #   @param created_at [Time] When the member was created
+      #
+      #   @param joined_at [Time] When the member joined the company
+      #
+      #   @param most_recent_action [Symbol, WhopSDK::Models::MemberMostRecentActions, nil] The different most recent actions a member can have.
+      #
+      #   @param most_recent_action_at [Time, nil] The time for the most recent action, if applicable.
+      #
+      #   @param phone [String, nil] The phone number for the member, if available.
+      #
+      #   @param status [Symbol, WhopSDK::Models::MemberStatuses] The status of the member
+      #
+      #   @param updated_at [Time] The timestamp of when this member was last updated
+      #
+      #   @param usd_total_spent [Float] How much money this customer has spent on the company's products and plans
+      #
+      #   @param user [WhopSDK::Models::MemberRetrieveResponse::User, nil] The user for this member, if any.
+
+      # @see WhopSDK::Models::MemberRetrieveResponse#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID 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 written name of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The company for the member.
+        #
+        #   @param id [String] The ID of the company
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The written name of the company.
+      end
+
+      # @see WhopSDK::Models::MemberRetrieveResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user account.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The digital mailing address of the user.
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute name
+        #   The user's full name.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The whop username.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, email:, name:, username:)
+        #   The user for this member, if any.
+        #
+        #   @param id [String] The internal ID of the user account.
+        #
+        #   @param email [String, nil] The digital mailing address of the user.
+        #
+        #   @param name [String, nil] The user's full name.
+        #
+        #   @param username [String] The whop username.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/member_statuses.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different statuses a Member can have.
+    module MemberStatuses
+      extend WhopSDK::Internal::Type::Enum
+
+      DRAFTED = :drafted
+      JOINED = :joined
+      LEFT = :left
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end