Class: SamplifyAPIClient::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/samplify_api_client/models/project.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Project

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
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
 
# File 'lib/samplify_api_client/models/project.rb', line 64

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

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

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

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

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

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

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

Instance Attribute Details

#category ⇒ Object

Returns the value of attribute category.



17
18
19
 
# File 'lib/samplify_api_client/models/project.rb', line 17

def category
  @category
end

#devices ⇒ Object

List of emails to subscribe to notifications



20
21
22
 
# File 'lib/samplify_api_client/models/project.rb', line 20

def devices
  @devices
end

#exclusions ⇒ Object

Returns the value of attribute exclusions.



22
23
24
 
# File 'lib/samplify_api_client/models/project.rb', line 22

def exclusions
  @exclusions
end

#ext_project_id ⇒ Object

Unique external project ID



25
26
27
 
# File 'lib/samplify_api_client/models/project.rb', line 25

def ext_project_id
  @ext_project_id
end

#line_items ⇒ Object

List of line items for the project.



28
29
30
 
# File 'lib/samplify_api_client/models/project.rb', line 28

def line_items
  @line_items
end

#notification_emails ⇒ Object

List of emails to subscribe to notifications



31
32
33
 
# File 'lib/samplify_api_client/models/project.rb', line 31

def notification_emails
  @notification_emails
end

#title ⇒ Object

Project title



34
35
36
 
# File 'lib/samplify_api_client/models/project.rb', line 34

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/samplify_api_client/models/project.rb', line 37

def self.attribute_map
  {
    :'category' => :'category',
    :'devices' => :'devices',
    :'exclusions' => :'exclusions',
    :'ext_project_id' => :'extProjectId',
    :'line_items' => :'lineItems',
    :'notification_emails' => :'notificationEmails',
    :'title' => :'title'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/samplify_api_client/models/project.rb', line 50

def self.swagger_types
  {
    :'category' => :'ProjectCategoryData',
    :'devices' => :'Array<String>',
    :'exclusions' => :'ExclusionData',
    :'ext_project_id' => :'String',
    :'line_items' => :'Array<LineItemData>',
    :'notification_emails' => :'Array<String>',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/samplify_api_client/models/project.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      devices == o.devices &&
      exclusions == o.exclusions &&
      ext_project_id == o.ext_project_id &&
      line_items == o.line_items &&
      notification_emails == o.notification_emails &&
      title == o.title
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/samplify_api_client/models/project.rb', line 193

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = SamplifyAPIClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/samplify_api_client/models/project.rb', line 259

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/samplify_api_client/models/project.rb', line 172

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/samplify_api_client/models/project.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/samplify_api_client/models/project.rb', line 165

def hash
  [category, devices, exclusions, ext_project_id, line_items, notification_emails, title].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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/samplify_api_client/models/project.rb', line 107

def list_invalid_properties
  invalid_properties = Array.new
  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
 
# File 'lib/samplify_api_client/models/project.rb', line 239

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
 
# File 'lib/samplify_api_client/models/project.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



233
234
235
 
# File 'lib/samplify_api_client/models/project.rb', line 233

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



134
135
136
137
138
139
140
141
 
# File 'lib/samplify_api_client/models/project.rb', line 134

def valid?
  return false if @category.nil?
  return false if @ext_project_id.nil?
  return false if @line_items.nil?
  return false if @notification_emails.nil?
  return false if @title.nil?
  true
end