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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/sentdm/models/template_create_params.rb', line 213

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

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

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


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

optional :id, Integer

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

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

Returns:



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

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

#type ⇒ String

Returns:

  • (String) 


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

required :type, String