Class: Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/template_create_params.rb

Defined Under Namespace

Classes: Props

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(name:, props:, type:, id: nil) ⇒ Object

Parameters:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/sentdm/models/template_create_params.rb', line 421

class Variable < Sentdm::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String]
  required :name, String

  # @!attribute props
  #
  #   @return [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable::Props]
  required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::SMS::Variable::Props }

  # @!attribute type
  #
  #   @return [String]
  required :type, String

  # @!attribute id
  #
  #   @return [Integer, nil]
  optional :id, Integer

  # @!method initialize(name:, props:, type:, id: nil)
  #   @param name [String]
  #   @param props [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable::Props]
  #   @param type [String]
  #   @param id [Integer]

  # @see Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable#props
  class Props < Sentdm::Internal::Type::BaseModel
    # @!attribute media_type
    #
    #   @return [String]
    required :media_type, String, api_name: :mediaType

    # @!attribute sample
    #
    #   @return [String]
    required :sample, String

    # @!attribute url
    #
    #   @return [String]
    required :url, String

    # @!attribute variable_type
    #
    #   @return [String]
    required :variable_type, String, api_name: :variableType

    # @!attribute alt
    #
    #   @return [String, nil]
    optional :alt, String, nil?: true

    # @!attribute regex
    #
    #   @return [String, nil]
    optional :regex, String, nil?: true

    # @!attribute short_url
    #
    #   @return [String, nil]
    optional :short_url, String, api_name: :shortUrl, nil?: true

    # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
    #   @param media_type [String]
    #   @param sample [String]
    #   @param url [String]
    #   @param variable_type [String]
    #   @param alt [String, nil]
    #   @param regex [String, nil]
    #   @param short_url [String, nil]
  end
end

Instance Attribute Details

#id ⇒ Integer?

Returns:

  • (Integer, nil) 


440
 
# File 'lib/sentdm/models/template_create_params.rb', line 440

optional :id, Integer

#name ⇒ String

Returns:

  • (String) 


425
 
# File 'lib/sentdm/models/template_create_params.rb', line 425

required :name, String

#props ⇒ Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable::Props

Returns:



430
 
# File 'lib/sentdm/models/template_create_params.rb', line 430

required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::SMS::Variable::Props }

#type ⇒ String

Returns:

  • (String) 


435
 
# File 'lib/sentdm/models/template_create_params.rb', line 435

required :type, String