Class: PureCloud::FlowExecutionLaunchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb

Overview

Parameters for launching a flow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowExecutionLaunchRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 66

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

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

  
  if attributes.has_key?(:'flowId')
    
    
    self.flow_id = attributes[:'flowId']
    
  
  end

  
  if attributes.has_key?(:'flowVersion')
    
    
    self.flow_version = attributes[:'flowVersion']
    
  
  end

  
  if attributes.has_key?(:'inputData')
    
    if (value = attributes[:'inputData']).is_a?(Array)
      self.input_data = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
end

Instance Attribute Details

#flow_id ⇒ Object

ID of the flow to launch.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 23

def flow_id
  @flow_id
end

#flow_version ⇒ Object

The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 26

def flow_version
  @flow_version
end

#input_data ⇒ Object

Input values to the flow. Valid values are defined by a flow’s input JSON schema.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 29

def input_data
  @input_data
end

#name ⇒ Object

A displayable name to assign to the new flow execution



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 32

def name
  @name
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/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 35

def self.attribute_map
  {
    
    :'flow_id' => :'flowId',
    
    :'flow_version' => :'flowVersion',
    
    :'input_data' => :'inputData',
    
    :'name' => :'name'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 50

def self.swagger_types
  {
    
    :'flow_id' => :'String',
    
    :'flow_version' => :'String',
    
    :'input_data' => :'Hash<String, Object>',
    
    :'name' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_id == o.flow_id &&
      flow_version == o.flow_version &&
      input_data == o.input_data &&
      name == o.name
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 213

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 273

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 194

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 189

def hash
  [flow_id, flow_version, input_data, name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



115
116
117
118
119
120
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



256
257
258
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 256

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



261
262
263
264
265
266
267
268
269
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 261

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 



251
252
253
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 251

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb', line 124

def valid?
  
  
  if @flow_id.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end