Class: PureCloud::FlowLaunchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/flow_launch_request.rb

Overview

Passed into a flow to describe an object to launch and returned from the operation with the Id populated with the flowInstance launched.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowLaunchRequest

Returns a new instance of FlowLaunchRequest.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'flowConfigId']
    self.flow_config_id = attributes[:'flowConfigId']
  end
  
  if attributes[:'flowInstanceName']
    self.flow_instance_name = attributes[:'flowInstanceName']
  end
  
  if attributes[:'inputData']
    self.input_data = attributes[:'inputData']
  end
  
  if attributes[:'launchType']
    self.launch_type = attributes[:'launchType']
  end
  
end

Instance Attribute Details

#flow_config_id ⇒ Object

ID of the flow to launch, will launch the most recently published version if a specific version is not specified.



23
24
25
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 23

def flow_config_id
  @flow_config_id
end

#flow_instance_name ⇒ Object

The displayable instance name to assign to the new flow instance (or omit to have one automatically generated)



26
27
28
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 26

def flow_instance_name
  @flow_instance_name
end

#input_data ⇒ Object

contains launch parameters or initializations for variables in the flow.



29
30
31
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 29

def input_data
  @input_data
end

#launch_type ⇒ Object

launch type of the flow - NORMAL or TEST



32
33
34
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 32

def launch_type
  @launch_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 35

def self.attribute_map
  {
    
    :'flow_config_id' => :'flowConfigId',
    
    :'flow_instance_name' => :'flowInstanceName',
    
    :'input_data' => :'inputData',
    
    :'launch_type' => :'launchType'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 50

def self.swagger_types
  {
    :'flow_config_id' => :'FlowConfigId',
    :'flow_instance_name' => :'String',
    :'input_data' => :'FlowInputData',
    :'launch_type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



95
96
97
98
99
100
101
102
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 95

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_config_id == o.flow_config_id &&
      flow_instance_name == o.flow_instance_name &&
      input_data == o.input_data &&
      launch_type == o.launch_type
end

#_deserialize(type, value) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 134

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 194

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 115

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


105
106
107
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 105

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



110
111
112
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 110

def hash
  [flow_config_id, flow_instance_name, input_data, launch_type].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



177
178
179
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 177

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



182
183
184
185
186
187
188
189
190
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 182

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



172
173
174
 
# File 'lib/purecloud/models/flow_launch_request.rb', line 172

def to_s
  to_hash.to_s
end