Class: Telnyx::Models::AI::Missions::Runs::PlanCreateParams::Step

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/missions/runs/plan_create_params.rb

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(description:, sequence:, step_id:, metadata: nil, parent_step_id: nil) ⇒ Object

Parameters:

  • description (String)
  • sequence (Integer)
  • step_id (String)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil)
  • parent_step_id (String) (defaults to: nil) 


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 29

class Step < Telnyx::Internal::Type::BaseModel
  # @!attribute description
  #
  #   @return [String]
  required :description, String

  # @!attribute sequence
  #
  #   @return [Integer]
  required :sequence, Integer

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

  # @!attribute metadata
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!attribute parent_step_id
  #
  #   @return [String, nil]
  optional :parent_step_id, String

  # @!method initialize(description:, sequence:, step_id:, metadata: nil, parent_step_id: nil)
  #   @param description [String]
  #   @param sequence [Integer]
  #   @param step_id [String]
  #   @param metadata [Hash{Symbol=>Object}]
  #   @param parent_step_id [String]
end

Instance Attribute Details

#description ⇒ String

Returns:

  • (String) 


33
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 33

required :description, String

#metadata ⇒ Hash{Symbol=>Object}?

Returns:

  • (Hash{Symbol=>Object}, nil) 


48
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 48

optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#parent_step_id ⇒ String?

Returns:

  • (String, nil) 


53
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 53

optional :parent_step_id, String

#sequence ⇒ Integer

Returns:

  • (Integer) 


38
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 38

required :sequence, Integer

#step_id ⇒ String

Returns:

  • (String) 


43
 
# File 'lib/telnyx/models/ai/missions/runs/plan_create_params.rb', line 43

required :step_id, String