Class: Dodopayments::Models::Brand

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/brand.rb,
sig/dodopayments/models/brand.rbs

Overview

See Also:

  • Dodopayments::Resources::Brands#create

Defined Under Namespace

Modules: VerificationStatus

Instance Attribute Summary collapse

Instance Method Summary collapse

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:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, archived_at: nil, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil) ⇒ Object

Parameters:

  • brand_id (String)
  • business_id (String)
  • enabled (Boolean)
  • statement_descriptor (String)
  • verification_enabled (Boolean)
  • verification_status (Symbol, Dodopayments::Models::Brand::VerificationStatus)
  • archived_at (Time, nil) (defaults to: nil) —

    Time the brand was archived. Null for an active brand.

  • description (String, nil) (defaults to: nil)
  • image (String, nil) (defaults to: nil)
  • name (String, nil) (defaults to: nil)
  • reason_for_hold (String, nil) (defaults to: nil) —

    Incase the brand verification fails or is put on hold

  • support_email (String, nil) (defaults to: nil)
  • url (String, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/brand.rb', line 74

Instance Attribute Details

#archived_at ⇒ Time?

Time the brand was archived. Null for an active brand.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


41
 
# File 'lib/dodopayments/models/brand.rb', line 41

optional :archived_at, Time, nil?: true

#brand_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/dodopayments/models/brand.rb', line 10

required :brand_id, String

#business_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/dodopayments/models/brand.rb', line 15

required :business_id, String

#description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


46
 
# File 'lib/dodopayments/models/brand.rb', line 46

optional :description, String, nil?: true

#enabled ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :enabled, Dodopayments::Internal::Type::Boolean

#image ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


51
 
# File 'lib/dodopayments/models/brand.rb', line 51

optional :image, String, nil?: true

#name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


56
 
# File 'lib/dodopayments/models/brand.rb', line 56

optional :name, String, nil?: true

#reason_for_hold ⇒ String?

Incase the brand verification fails or is put on hold

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/dodopayments/models/brand.rb', line 62

optional :reason_for_hold, String, nil?: true

#statement_descriptor ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/dodopayments/models/brand.rb', line 25

required :statement_descriptor, String

#support_email ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


67
 
# File 'lib/dodopayments/models/brand.rb', line 67

optional :support_email, String, nil?: true

#url ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


72
 
# File 'lib/dodopayments/models/brand.rb', line 72

optional :url, String, nil?: true

#verification_enabled ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


30
 
# File 'lib/dodopayments/models/brand.rb', line 30

required :verification_enabled, Dodopayments::Internal::Type::Boolean

#verification_status ⇒ Symbol, Dodopayments::Models::Brand::VerificationStatus

Parameters:

  • value (Dodopayments::Models::Brand::verification_status)

Returns:



35
 
# File 'lib/dodopayments/models/brand.rb', line 35

required :verification_status, enum: -> { Dodopayments::Brand::VerificationStatus }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/dodopayments/models/brand.rbs', line 63

def to_hash: -> {