Class: Spatio::Note

Inherits:
ApiModelBase show all
Defined in:
lib/spatio-sdk/models/note.rb

Overview

A markdown note. Notes belong to exactly one connected account (‘accountId` + `provider`). The native provider stores notes in the Spatio database; external providers (Notion, Google Keep, etc.) store them upstream and round-trip through Spatio.

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 = {}) ⇒ Note

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
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
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/spatio-sdk/models/note.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Spatio::Note` 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 `Spatio::Note`. 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?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'properties')
    if (value = attributes[:'properties']).is_a?(Hash)
      self.properties = value
    end
  end

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Connected-account row this note belongs to.



26
27
28
 
# File 'lib/spatio-sdk/models/note.rb', line 26

def 
  @account_id
end

#archived ⇒ Object

Returns the value of attribute archived.



48
49
50
 
# File 'lib/spatio-sdk/models/note.rb', line 48

def archived
  @archived
end

#content ⇒ Object

Markdown body. The block tree at ‘/v1/notes/#id/blocks` is the canonical structured representation; `content` is a flattened markdown view kept for clients that don’t render blocks.



34
35
36
 
# File 'lib/spatio-sdk/models/note.rb', line 34

def content
  @content
end

#cover_image ⇒ Object

URL of the note’s cover image.



40
41
42
 
# File 'lib/spatio-sdk/models/note.rb', line 40

def cover_image
  @cover_image
end

#created_at ⇒ Object

Returns the value of attribute created_at.



50
51
52
 
# File 'lib/spatio-sdk/models/note.rb', line 50

def created_at
  @created_at
end

#icon ⇒ Object

Emoji or short string used as the note’s icon.



37
38
39
 
# File 'lib/spatio-sdk/models/note.rb', line 37

def icon
  @icon
end

#id ⇒ Object

Stable provider id for the note.



20
21
22
 
# File 'lib/spatio-sdk/models/note.rb', line 20

def id
  @id
end

#last_edited_by ⇒ Object

User id of the most recent editor.



55
56
57
 
# File 'lib/spatio-sdk/models/note.rb', line 55

def last_edited_by
  @last_edited_by
end

#owner_user_id ⇒ Object

User id of the note’s owner. Surfaced so the renderer can show "Shared with you" when ‘ownerUserId` differs from the viewer’s id. Empty for non-native providers.



29
30
31
 
# File 'lib/spatio-sdk/models/note.rb', line 29

def owner_user_id
  @owner_user_id
end

#parent_id ⇒ Object

Parent note id when notes are nested.



43
44
45
 
# File 'lib/spatio-sdk/models/note.rb', line 43

def parent_id
  @parent_id
end

#properties ⇒ Object

Free-form provider-specific properties (tags, etc.).



46
47
48
 
# File 'lib/spatio-sdk/models/note.rb', line 46

def properties
  @properties
end

#provider ⇒ Object

Registered provider id (e.g. ‘native-notes`).



23
24
25
 
# File 'lib/spatio-sdk/models/note.rb', line 23

def provider
  @provider
end

#title ⇒ Object

Returns the value of attribute title.



31
32
33
 
# File 'lib/spatio-sdk/models/note.rb', line 31

def title
  @title
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



52
53
54
 
# File 'lib/spatio-sdk/models/note.rb', line 52

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/spatio-sdk/models/note.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/spatio-sdk/models/note.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/spatio-sdk/models/note.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'provider' => :'provider',
    :'account_id' => :'accountId',
    :'owner_user_id' => :'ownerUserId',
    :'title' => :'title',
    :'content' => :'content',
    :'icon' => :'icon',
    :'cover_image' => :'coverImage',
    :'parent_id' => :'parentId',
    :'properties' => :'properties',
    :'archived' => :'archived',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'last_edited_by' => :'lastEditedBy'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/spatio-sdk/models/note.rb', line 342

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_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
 
# File 'lib/spatio-sdk/models/note.rb', line 108

def self.openapi_nullable
  Set.new([
    :'parent_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/spatio-sdk/models/note.rb', line 88

def self.openapi_types
  {
    :'id' => :'String',
    :'provider' => :'String',
    :'account_id' => :'String',
    :'owner_user_id' => :'String',
    :'title' => :'String',
    :'content' => :'String',
    :'icon' => :'String',
    :'cover_image' => :'String',
    :'parent_id' => :'String',
    :'properties' => :'Hash<String, Object>',
    :'archived' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'last_edited_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/spatio-sdk/models/note.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      provider == o.provider &&
       == o. &&
      owner_user_id == o.owner_user_id &&
      title == o.title &&
      content == o.content &&
      icon == o.icon &&
      cover_image == o.cover_image &&
      parent_id == o.parent_id &&
      properties == o.properties &&
      archived == o.archived &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      last_edited_by == o.last_edited_by
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/spatio-sdk/models/note.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/spatio-sdk/models/note.rb', line 335

def hash
  [id, provider, , owner_user_id, title, content, icon, cover_image, parent_id, properties, archived, created_at, updated_at, last_edited_by].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



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
 
# File 'lib/spatio-sdk/models/note.rb', line 203

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/spatio-sdk/models/note.rb', line 364

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:

  • (Boolean) —

    true if the model is valid



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/spatio-sdk/models/note.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @title.nil?
  return false if @content.nil?
  return false if @archived.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end