Class: Stigg::Models::V1::CouponCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::CouponCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stigg/models/v1/coupon_create_params.rb

Overview

See Also:

• Resources::V1::Coupons#create

Defined Under Namespace

Classes: AmountsOff

Instance Attribute Summary

• #amounts_off ⇒ Array<Stigg::Models::V1::CouponCreateParams::AmountsOff>^?

  Fixed amount discounts in different currencies.

• #description ⇒ String^?

  Description of the coupon.

• #duration_in_months ⇒ Integer^?

  Duration of the coupon validity in months.

• #id ⇒ String

  The unique identifier for the entity.

• #metadata ⇒ Hash{Symbol=>String}^?

  Metadata associated with the entity.

• #name ⇒ String

  Name of the coupon.

• #percent_off ⇒ Float^?

  Percentage discount off the original price.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Stigg::Internal::Type::BaseModel

Instance Attribute Details

#amounts_off ⇒ Array<Stigg::Models::V1::CouponCreateParams::AmountsOff>^?

Fixed amount discounts in different currencies

Returns:

• (Array<Stigg::Models::V1::CouponCreateParams::AmountsOff>, nil)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 21

required :amounts_off,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::CouponCreateParams::AmountsOff] },
api_name: :amountsOff,
nil?: true

#description ⇒ String^?

Description of the coupon

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 30

required :description, String, nil?: true

#duration_in_months ⇒ Integer^?

Duration of the coupon validity in months

Returns:

• (Integer, nil)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 36

required :duration_in_months, Integer, api_name: :durationInMonths, nil?: true

#id ⇒ String

The unique identifier for the entity

Returns:

• (String)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 15

required :id, String

#metadata ⇒ Hash{Symbol=>String}^?

Metadata associated with the entity

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 42

required :metadata, Stigg::Internal::Type::HashOf[String], nil?: true

#name ⇒ String

Name of the coupon

Returns:

• (String)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 48

required :name, String

#percent_off ⇒ Float^?

Percentage discount off the original price

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/coupon_create_params.rb', line 54

required :percent_off, Float, api_name: :percentOff, nil?: true