Class: PureCloud::Script

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Script

Returns a new instance of Script.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/purecloud/models/script.rb', line 90

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'versionId']
    self.version_id = attributes[:'versionId']
  end
  
  if attributes[:'createdDate']
    self.created_date = attributes[:'createdDate']
  end
  
  if attributes[:'modifiedDate']
    self.modified_date = attributes[:'modifiedDate']
  end
  
  if attributes[:'publishedDate']
    self.published_date = attributes[:'publishedDate']
  end
  
  if attributes[:'versionDate']
    self.version_date = attributes[:'versionDate']
  end
  
  if attributes[:'startPageId']
    self.start_page_id = attributes[:'startPageId']
  end
  
  if attributes[:'startPageName']
    self.start_page_name = attributes[:'startPageName']
  end
  
  if attributes[:'features']
    self.features = attributes[:'features']
  end
  
  if attributes[:'variables']
    self.variables = attributes[:'variables']
  end
  
  if attributes[:'customActions']
    self.custom_actions = attributes[:'customActions']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#created_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



13
14
15
# File 'lib/purecloud/models/script.rb', line 13

def created_date
  @created_date
end

#custom_actionsObject

Returns the value of attribute custom_actions.



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

def custom_actions
  @custom_actions
end

#featuresObject

Returns the value of attribute features.



28
29
30
# File 'lib/purecloud/models/script.rb', line 28

def features
  @features
end

#idObject

The globally unique identifier for the object.



6
7
8
# File 'lib/purecloud/models/script.rb', line 6

def id
  @id
end

#modified_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



16
17
18
# File 'lib/purecloud/models/script.rb', line 16

def modified_date
  @modified_date
end

#nameObject

Returns the value of attribute name.



8
9
10
# File 'lib/purecloud/models/script.rb', line 8

def name
  @name
end

#published_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



19
20
21
# File 'lib/purecloud/models/script.rb', line 19

def published_date
  @published_date
end

#self_uriObject

The URI for this object



35
36
37
# File 'lib/purecloud/models/script.rb', line 35

def self_uri
  @self_uri
end

#start_page_idObject

Returns the value of attribute start_page_id.



24
25
26
# File 'lib/purecloud/models/script.rb', line 24

def start_page_id
  @start_page_id
end

#start_page_nameObject

Returns the value of attribute start_page_name.



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

def start_page_name
  @start_page_name
end

#variablesObject

Returns the value of attribute variables.



30
31
32
# File 'lib/purecloud/models/script.rb', line 30

def variables
  @variables
end

#version_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



22
23
24
# File 'lib/purecloud/models/script.rb', line 22

def version_date
  @version_date
end

#version_idObject

Returns the value of attribute version_id.



10
11
12
# File 'lib/purecloud/models/script.rb', line 10

def version_id
  @version_id
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/purecloud/models/script.rb', line 38

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'version_id' => :'versionId',
    
    :'created_date' => :'createdDate',
    
    :'modified_date' => :'modifiedDate',
    
    :'published_date' => :'publishedDate',
    
    :'version_date' => :'versionDate',
    
    :'start_page_id' => :'startPageId',
    
    :'start_page_name' => :'startPageName',
    
    :'features' => :'features',
    
    :'variables' => :'variables',
    
    :'custom_actions' => :'customActions',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/purecloud/models/script.rb', line 71

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'version_id' => :'String',
    :'created_date' => :'DateTime',
    :'modified_date' => :'DateTime',
    :'published_date' => :'DateTime',
    :'version_date' => :'DateTime',
    :'start_page_id' => :'String',
    :'start_page_name' => :'String',
    :'features' => :'Object',
    :'variables' => :'Object',
    :'custom_actions' => :'Object',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/purecloud/models/script.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      version_id == o.version_id &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      published_date == o.published_date &&
      version_date == o.version_date &&
      start_page_id == o.start_page_id &&
      start_page_name == o.start_page_name &&
      features == o.features &&
      variables == o.variables &&
      custom_actions == o.custom_actions &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/purecloud/models/script.rb', line 200

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/purecloud/models/script.rb', line 257

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/purecloud/models/script.rb', line 181

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


171
172
173
# File 'lib/purecloud/models/script.rb', line 171

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



176
177
178
# File 'lib/purecloud/models/script.rb', line 176

def hash
  [id, name, version_id, created_date, modified_date, published_date, version_date, start_page_id, start_page_name, features, variables, custom_actions, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



240
241
242
# File 'lib/purecloud/models/script.rb', line 240

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



245
246
247
248
249
250
251
252
253
# File 'lib/purecloud/models/script.rb', line 245

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_sObject



235
236
237
# File 'lib/purecloud/models/script.rb', line 235

def to_s
  to_hash.to_s
end