Class: Dodopayments::Models::SubscriptionListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::SubscriptionListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/subscription_list_params.rb

Overview

See Also:

• Resources::Subscriptions#list

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #brand_id ⇒ String^?

  filter by Brand id.

• #created_at_gte ⇒ Time^?

  Get events after this created time.

• #created_at_lte ⇒ Time^?

  Get events created before this time.

• #customer_id ⇒ String^?

  Filter by customer id.

• #page_number ⇒ Integer^?

  Page number default is 0.

• #page_size ⇒ Integer^?

  Page size default is 10 max is 100.

• #status ⇒ Symbol, ...

  Filter by status.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: 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(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• brand_id (String) (defaults to: nil) —

  filter by Brand id

• created_at_gte (Time) (defaults to: nil) —

  Get events after this created time

• created_at_lte (Time) (defaults to: nil) —

  Get events created before this time

• customer_id (String) (defaults to: nil) —

  Filter by customer id

• page_number (Integer) (defaults to: nil) —

  Page number default is 0

• page_size (Integer) (defaults to: nil) —

  Page size default is 10 max is 100

• status (Symbol, Dodopayments::Models::SubscriptionListParams::Status) (defaults to: nil) —

  Filter by status

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

# File 'lib/dodopayments/models/subscription_list_params.rb', line 52

Instance Attribute Details

#brand_id ⇒ String^?

filter by Brand id

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 14

optional :brand_id, String

#created_at_gte ⇒ Time^?

Get events after this created time

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 20

optional :created_at_gte, Time

#created_at_lte ⇒ Time^?

Get events created before this time

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 26

optional :created_at_lte, Time

#customer_id ⇒ String^?

Filter by customer id

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 32

optional :customer_id, String

#page_number ⇒ Integer^?

Page number default is 0

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 38

optional :page_number, Integer

#page_size ⇒ Integer^?

Page size default is 10 max is 100

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 44

optional :page_size, Integer

#status ⇒ Symbol, ...

Filter by status

Returns:

• (Symbol, Dodopayments::Models::SubscriptionListParams::Status, nil)

# File 'lib/dodopayments/models/subscription_list_params.rb', line 50

optional :status, enum: -> { Dodopayments::SubscriptionListParams::Status }