Class: MetronomeSDK::Models::V1::CreditGrantListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::CreditGrantListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/credit_grant_list_params.rb

Overview

See Also:

• Resources::V1::CreditGrants#list

Instance Attribute Summary

• #credit_grant_ids ⇒ Array<String>^?

  An array of credit grant IDs.

• #credit_type_ids ⇒ Array<String>^?

  An array of credit type IDs.

• #customer_ids ⇒ Array<String>^?

  An array of Metronome customer IDs.

• #effective_before ⇒ Time^?

  Only return credit grants that are effective before this timestamp (exclusive).

• #limit ⇒ Integer^?

  Max number of results that should be returned.

• #next_page ⇒ String^?

  Cursor that indicates where the next page of results should start.

• #not_expiring_before ⇒ Time^?

  Only return credit grants that expire at or after this timestamp.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, next_page: nil, credit_grant_ids: nil, credit_type_ids: nil, customer_ids: nil, effective_before: nil, not_expiring_before: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CreditGrantListParams for more details.

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(limit: nil, next_page: nil, credit_grant_ids: nil, credit_type_ids: nil, customer_ids: nil, effective_before: nil, not_expiring_before: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::CreditGrantListParams for more details.

Parameters:

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

  Max number of results that should be returned

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

  Cursor that indicates where the next page of results should start.

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

  An array of credit grant IDs. If this is specified, neither credit_type_ids nor

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

  An array of credit type IDs. This must not be specified if credit_grant_ids is s

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

  An array of Metronome customer IDs. This must not be specified if credit_grant_i

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

  Only return credit grants that are effective before this timestamp (exclusive).

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

  Only return credit grants that expire at or after this timestamp.

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

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 56

Instance Attribute Details

#credit_grant_ids ⇒ Array<String>^?

An array of credit grant IDs. If this is specified, neither credit_type_ids nor customer_ids may be specified.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 28

optional :credit_grant_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#credit_type_ids ⇒ Array<String>^?

An array of credit type IDs. This must not be specified if credit_grant_ids is specified.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 35

optional :credit_type_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#customer_ids ⇒ Array<String>^?

An array of Metronome customer IDs. This must not be specified if credit_grant_ids is specified.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 42

optional :customer_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#effective_before ⇒ Time^?

Only return credit grants that are effective before this timestamp (exclusive).

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 48

optional :effective_before, Time

#limit ⇒ Integer^?

Max number of results that should be returned

Returns:

• (Integer, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 15

optional :limit, Integer

#next_page ⇒ String^?

Cursor that indicates where the next page of results should start.

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 21

optional :next_page, String

#not_expiring_before ⇒ Time^?

Only return credit grants that expire at or after this timestamp.

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v1/credit_grant_list_params.rb', line 54

optional :not_expiring_before, Time