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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/sentdm/models/template_create_params.rb', line 317

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

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

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


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

optional :id, Integer

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

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

Returns:



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

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

#type ⇒ String

Returns:

  • (String) 


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

required :type, String