Class: WhopSDK::Models::MembershipListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::MembershipListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/membership_list_params.rb

Overview

See Also:

• Resources::Memberships#list

Defined Under Namespace

Modules: CancelOption, Order

Instance Attribute Summary

• #after ⇒ String^?

  Returns the elements in the list that come after the specified cursor.

• #before ⇒ String^?

  Returns the elements in the list that come before the specified cursor.

• #cancel_options ⇒ Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>^?

  The cancel options to filter the memberships by.

• #company_id ⇒ String^?

  The ID of the company to list memberships for.

• #created_after ⇒ Time^?

  The minimum creation date to filter by.

• #created_before ⇒ Time^?

  The maximum creation date to filter by.

• #direction ⇒ Symbol, ...

  The direction of the sort.

• #first ⇒ Integer^?

  Returns the first n elements from the list.

• #last ⇒ Integer^?

  Returns the last n elements from the list.

• #order ⇒ Symbol, ...

  Which columns can be used to sort.

• #plan_ids ⇒ Array<String>^?

  The plan IDs to filter the memberships by.

• #product_ids ⇒ Array<String>^?

  The product IDs to filter the memberships by.

• #promo_code_ids ⇒ Array<String>^?

  The promo code IDs to filter the memberships by.

• #statuses ⇒ Array<Symbol, WhopSDK::Models::MembershipStatus>^?

  The membership status to filter the memberships by.

• #user_ids ⇒ Array<String>^?

  Only return memberships from these whop user ids.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {}) ⇒ Object

Parameters:

• after (String, nil) (defaults to: nil) —

  Returns the elements in the list that come after the specified cursor.

• before (String, nil) (defaults to: nil) —

  Returns the elements in the list that come before the specified cursor.

• cancel_options (Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil) (defaults to: nil) —

  The cancel options to filter the memberships by

• company_id (String, nil) (defaults to: nil) —

  The ID of the company to list memberships for

• created_after (Time, nil) (defaults to: nil) —

  The minimum creation date to filter by

• created_before (Time, nil) (defaults to: nil) —

  The maximum creation date to filter by

• direction (Symbol, WhopSDK::Models::Direction, nil) (defaults to: nil) —

  The direction of the sort.

• first (Integer, nil) (defaults to: nil) —

  Returns the first n elements from the list.

• last (Integer, nil) (defaults to: nil) —

  Returns the last n elements from the list.

• order (Symbol, WhopSDK::Models::MembershipListParams::Order, nil) (defaults to: nil) —

  Which columns can be used to sort.

• plan_ids (Array<String>, nil) (defaults to: nil) —

  The plan IDs to filter the memberships by

• product_ids (Array<String>, nil) (defaults to: nil) —

  The product IDs to filter the memberships by

• promo_code_ids (Array<String>, nil) (defaults to: nil) —

  The promo code IDs to filter the memberships by

• statuses (Array<Symbol, WhopSDK::Models::MembershipStatus>, nil) (defaults to: nil) —

  The membership status to filter the memberships by

• user_ids (Array<String>, nil) (defaults to: nil) —

  Only return memberships from these whop user ids

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/whop_sdk/models/membership_list_params.rb', line 102

Instance Attribute Details

#after ⇒ String^?

Returns the elements in the list that come after the specified cursor.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 14

optional :after, String, nil?: true

#before ⇒ String^?

Returns the elements in the list that come before the specified cursor.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 20

optional :before, String, nil?: true

#cancel_options ⇒ Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>^?

The cancel options to filter the memberships by

Returns:

• (Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 26

optional :cancel_options,
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MembershipListParams::CancelOption] },
nil?: true

#company_id ⇒ String^?

The ID of the company to list memberships for

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 34

optional :company_id, String, nil?: true

#created_after ⇒ Time^?

The minimum creation date to filter by

Returns:

• (Time, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 40

optional :created_after, Time, nil?: true

#created_before ⇒ Time^?

The maximum creation date to filter by

Returns:

• (Time, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 46

optional :created_before, Time, nil?: true

#direction ⇒ Symbol, ...

The direction of the sort.

Returns:

• (Symbol, WhopSDK::Models::Direction, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 52

optional :direction, enum: -> { WhopSDK::Direction }, nil?: true

#first ⇒ Integer^?

Returns the first n elements from the list.

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 58

optional :first, Integer, nil?: true

#last ⇒ Integer^?

Returns the last n elements from the list.

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 64

optional :last, Integer, nil?: true

#order ⇒ Symbol, ...

Which columns can be used to sort.

Returns:

• (Symbol, WhopSDK::Models::MembershipListParams::Order, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 70

optional :order, enum: -> { WhopSDK::MembershipListParams::Order }, nil?: true

#plan_ids ⇒ Array<String>^?

The plan IDs to filter the memberships by

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 76

optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#product_ids ⇒ Array<String>^?

The product IDs to filter the memberships by

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 82

optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#promo_code_ids ⇒ Array<String>^?

The promo code IDs to filter the memberships by

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 88

optional :promo_code_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#statuses ⇒ Array<Symbol, WhopSDK::Models::MembershipStatus>^?

The membership status to filter the memberships by

Returns:

• (Array<Symbol, WhopSDK::Models::MembershipStatus>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 94

optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::MembershipStatus] }, nil?: true

#user_ids ⇒ Array<String>^?

Only return memberships from these whop user ids

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 100

optional :user_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/membership_list_params.rb', line 148