Class: Zernio::BusinessAgentSkill

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/business_agent_skill.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BusinessAgentSkill

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
150
151
152
153
154
155
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 110

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::BusinessAgentSkill` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::BusinessAgentSkill`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'skill')
    self.skill = attributes[:'skill']
  else
    self.skill = nil
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'channel')
    self.channel = attributes[:'channel']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end
end

Instance Attribute Details

#channel ⇒ Object

Returns the value of attribute channel.



29
30
31
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 29

def channel
  @channel
end

#created_at ⇒ Object

Unix seconds.



32
33
34
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 32

def created_at
  @created_at
end

#description ⇒ Object

When the agent should apply the skill.



22
23
24
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 22

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



27
28
29
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 27

def id
  @id
end

#skill ⇒ Object

The instructions themselves. Avoid two skills that both claim priority for the same situation.



25
26
27
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 25

def skill
  @skill
end

#status ⇒ Object

pending_review right after a write; blocked means Meta content review rejected it and the agent never applies it.



35
36
37
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 35

def status
  @status
end

#title ⇒ Object

Lowercase letters, digits and hyphens, e.g. greeting-skill.



19
20
21
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 19

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 78

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 60

def self.attribute_map
  {
    :'title' => :'title',
    :'description' => :'description',
    :'skill' => :'skill',
    :'id' => :'id',
    :'channel' => :'channel',
    :'created_at' => :'created_at',
    :'status' => :'status'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 301

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



102
103
104
105
106
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 102

def self.openapi_all_of
  [
  :'BusinessAgentSkillInput'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 96

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 83

def self.openapi_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'skill' => :'String',
    :'id' => :'String',
    :'channel' => :'String',
    :'created_at' => :'Integer',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      skill == o.skill &&
      id == o.id &&
      channel == o.channel &&
      created_at == o.created_at &&
      status == o.status
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


288
289
290
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



294
295
296
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 294

def hash
  [title, description, skill, id, channel, created_at, status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 64
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 64.')
  end

  pattern = Regexp.new(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
  if !@title.nil? && @title !~ pattern
    invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
  end

  if !@description.nil? && @description.to_s.length > 1024
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1024.')
  end

  if @skill.nil?
    invalid_properties.push('invalid value for "skill", skill cannot be nil.')
  end

  if @skill.to_s.length > 20000
    invalid_properties.push('invalid value for "skill", the character length must be smaller than or equal to 20000.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 323

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/zernio-sdk/models/business_agent_skill.rb', line 192

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 64
  return false if !@title.nil? && @title !~ Regexp.new(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
  return false if !@description.nil? && @description.to_s.length > 1024
  return false if @skill.nil?
  return false if @skill.to_s.length > 20000
  return false if @id.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "pending_review", "blocked"])
  return false unless status_validator.valid?(@status)
  true
end