Class: WhopSDK::Models::PromoCodeListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/promo_code_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(company_id: , after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, plan_ids: nil, product_ids: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

  • company_id (String) (defaults to: ) —

    The ID of the company to list promo codes for

  • 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.

  • 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

  • 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.

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

    Filter promo codes by plan ID(s)

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

    Filter promo codes by product ID(s)

  • status (Symbol, WhopSDK::Models::PromoCodeStatus, nil) (defaults to: nil) —

    Statuses for promo codes

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



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

Instance Attribute Details

#after ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :after, String, nil?: true

#before ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :before, String, nil?: true

#company_id ⇒ String

The ID of the company to list promo codes for

Returns:

  • (String) 


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

required :company_id, String

#created_after ⇒ Time?

The minimum creation date to filter by

Returns:

  • (Time, nil) 


32
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 32

optional :created_after, Time, nil?: true

#created_before ⇒ Time?

The maximum creation date to filter by

Returns:

  • (Time, nil) 


38
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 38

optional :created_before, Time, nil?: true

#first ⇒ Integer?

Returns the first n elements from the list.

Returns:

  • (Integer, nil) 


44
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 44

optional :first, Integer, nil?: true

#last ⇒ Integer?

Returns the last n elements from the list.

Returns:

  • (Integer, nil) 


50
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 50

optional :last, Integer, nil?: true

#plan_ids ⇒ Array<String>?

Filter promo codes by plan ID(s)

Returns:

  • (Array<String>, nil) 


56
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 56

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

#product_ids ⇒ Array<String>?

Filter promo codes by product ID(s)

Returns:

  • (Array<String>, nil) 


62
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 62

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

#status ⇒ Symbol, ...

Statuses for promo codes

Returns:



68
 
# File 'lib/whop_sdk/models/promo_code_list_params.rb', line 68

optional :status, enum: -> { WhopSDK::PromoCodeStatus }, nil?: true