Class: Sentdm::Models::TemplateCreateParams::Definition::Footer::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:



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/sentdm/models/template_create_params.rb', line 777

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

  # @!attribute props
  #
  #   @return [Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable::Props]
  required :props, -> { Sentdm::TemplateCreateParams::Definition::Footer::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::Footer::Variable::Props]
  #   @param type [String]
  #   @param id [Integer]

  # @see Sentdm::Models::TemplateCreateParams::Definition::Footer::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) 


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

optional :id, Integer

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#props ⇒ Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable::Props

Returns:



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

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

#type ⇒ String

Returns:

  • (String) 


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

required :type, String