Class: Orb::Models::CouponListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/coupon_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(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::CouponListParams for more details.

Parameters:

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

    Cursor for pagination. This can be populated by the ‘next_cursor` value returned

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

    The number of items to fetch. Defaults to 20.

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

    Filter to coupons matching this redemption code.

  • show_archived (Boolean, nil) (defaults to: nil) —

    Show archived coupons as well (by default, this endpoint only returns active cou

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



# File 'lib/orb/models/coupon_list_params.rb', line 36

Instance Attribute Details

#cursor ⇒ String?

Cursor for pagination. This can be populated by the ‘next_cursor` value returned from the initial request.

Returns:

  • (String, nil) 


15
 
# File 'lib/orb/models/coupon_list_params.rb', line 15

optional :cursor, String, nil?: true

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Returns:

  • (Integer, nil) 


21
 
# File 'lib/orb/models/coupon_list_params.rb', line 21

optional :limit, Integer

#redemption_code ⇒ String?

Filter to coupons matching this redemption code.

Returns:

  • (String, nil) 


27
 
# File 'lib/orb/models/coupon_list_params.rb', line 27

optional :redemption_code, String, nil?: true

#show_archived ⇒ Boolean?

Show archived coupons as well (by default, this endpoint only returns active coupons).

Returns:

  • (Boolean, nil) 


34
 
# File 'lib/orb/models/coupon_list_params.rb', line 34

optional :show_archived, Orb::Internal::Type::Boolean, nil?: true