Class: PureCloud::CreateCallbackCommand

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCallbackCommand

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 75

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?(:'scriptId')
    self.script_id = attributes[:'scriptId']
  end

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

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

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

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

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

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

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

end

Instance Attribute Details

#callback_numbers ⇒ Object

A list of phone numbers for the callback.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 34

def callback_numbers
  @callback_numbers
end

#callback_scheduled_time ⇒ Object

The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 37

def callback_scheduled_time
  @callback_scheduled_time
end

#callback_user_name ⇒ Object

The name of the party to be called back.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 31

def callback_user_name
  @callback_user_name
end

#country_code ⇒ Object

The country code to be associated with the callback numbers.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 40

def country_code
  @country_code
end

#data ⇒ Object

A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { "notes": "ready to close the deal!", "customerPreferredName": "Doc" }



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 43

def data
  @data
end

#queue_id ⇒ Object

The identifier of the queue to be used for the callback. Either queueId or routingData is required.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 25

def queue_id
  @queue_id
end

#routing_data ⇒ Object

The routing data to be used for the callback. Either queueId or routingData is required.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 28

def routing_data
  @routing_data
end

#script_id ⇒ Object

The identifier of the script to be used for the callback



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 22

def script_id
  @script_id
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 46

def self.attribute_map
  {
    :'script_id' => :'scriptId',
    :'queue_id' => :'queueId',
    :'routing_data' => :'routingData',
    :'callback_user_name' => :'callbackUserName',
    :'callback_numbers' => :'callbackNumbers',
    :'callback_scheduled_time' => :'callbackScheduledTime',
    :'country_code' => :'countryCode',
    :'data' => :'data'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 60

def self.swagger_types
  {
    :'script_id' => :'String',
    :'queue_id' => :'String',
    :'routing_data' => :'RoutingData',
    :'callback_user_name' => :'String',
    :'callback_numbers' => :'Array<String>',
    :'callback_scheduled_time' => :'DateTime',
    :'country_code' => :'String',
    :'data' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      script_id == o.script_id &&
      queue_id == o.queue_id &&
      routing_data == o.routing_data &&
      callback_user_name == o.callback_user_name &&
      callback_numbers == o.callback_numbers &&
      callback_scheduled_time == o.callback_scheduled_time &&
      country_code == o.country_code &&
      data == o.data
end

#_deserialize(type, value) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 182

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 242

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 163

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


152
153
154
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 158

def hash
  [script_id, queue_id, routing_data, callback_user_name, callback_numbers, callback_scheduled_time, country_code, data].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



121
122
123
124
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 121

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))



225
226
227
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



230
231
232
233
234
235
236
237
238
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 230

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 



220
221
222
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 220

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



128
129
130
131
132
133
 
# File 'lib/purecloudplatformclientv2/models/create_callback_command.rb', line 128

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

end