Class: MetronomeSDK::Models::V1::CustomerListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/customer_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(customer_ids: nil, ingest_alias: nil, limit: nil, next_page: nil, only_archived: nil, salesforce_account_ids: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Filter the customer list by customer_id. Up to 100 ids can be provided.

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

    Filter the customer list by ingest_alias

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

  • only_archived (Boolean) (defaults to: nil) —

    Filter the customer list to only return archived customers. By default, only act

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

    Filter the customer list by salesforce_account_id. Up to 100 ids can be provide

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



# File 'lib/metronome_sdk/models/v1/customer_list_params.rb', line 49

Instance Attribute Details

#customer_ids ⇒ Array<String>?

Filter the customer list by customer_id. Up to 100 ids can be provided.

Returns:

  • (Array<String>, nil) 


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

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

#ingest_alias ⇒ String?

Filter the customer list by ingest_alias

Returns:

  • (String, nil) 


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

optional :ingest_alias, String

#limit ⇒ Integer?

Max number of results that should be returned

Returns:

  • (Integer, nil) 


27
 
# File 'lib/metronome_sdk/models/v1/customer_list_params.rb', line 27

optional :limit, Integer

#next_page ⇒ String?

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

Returns:

  • (String, nil) 


33
 
# File 'lib/metronome_sdk/models/v1/customer_list_params.rb', line 33

optional :next_page, String

#only_archived ⇒ Boolean?

Filter the customer list to only return archived customers. By default, only active customers are returned.

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/metronome_sdk/models/v1/customer_list_params.rb', line 40

optional :only_archived, MetronomeSDK::Internal::Type::Boolean

#salesforce_account_ids ⇒ Array<String>?

Filter the customer list by salesforce_account_id. Up to 100 ids can be provided.

Returns:

  • (Array<String>, nil) 


47
 
# File 'lib/metronome_sdk/models/v1/customer_list_params.rb', line 47

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