evernote-thrift 1.23.0 → 1.23.1
Sign up to get free protection for your applications and to get access to all the features.
- data/evernote-thrift.gemspec +1 -1
- data/lib/Evernote/EDAM/errors_constants.rb +5 -4
- data/lib/Evernote/EDAM/errors_types.rb +118 -117
- data/lib/Evernote/EDAM/limits_constants.rb +148 -147
- data/lib/Evernote/EDAM/limits_types.rb +5 -4
- data/lib/Evernote/EDAM/note_store.rb +4989 -4989
- data/lib/Evernote/EDAM/note_store_constants.rb +5 -4
- data/lib/Evernote/EDAM/note_store_types.rb +1078 -1077
- data/lib/Evernote/EDAM/types_constants.rb +11 -10
- data/lib/Evernote/EDAM/types_types.rb +2196 -2166
- data/lib/Evernote/EDAM/user_store.rb +603 -603
- data/lib/Evernote/EDAM/user_store_constants.rb +7 -6
- data/lib/Evernote/EDAM/user_store_types.rb +284 -283
- data/lib/thrift.rb +2 -0
- data/lib/thrift/bytes.rb +131 -0
- data/lib/thrift/protocol/base_protocol.rb +97 -10
- data/lib/thrift/protocol/binary_protocol.rb +15 -7
- data/lib/thrift/protocol/compact_protocol.rb +13 -4
- data/lib/thrift/protocol/json_protocol.rb +765 -0
- data/lib/thrift/struct.rb +1 -1
- data/lib/thrift/struct_union.rb +3 -3
- data/lib/thrift/transport/base_transport.rb +22 -20
- data/lib/thrift/transport/buffered_transport.rb +17 -11
- data/lib/thrift/transport/framed_transport.rb +12 -11
- data/lib/thrift/transport/http_client_transport.rb +6 -4
- data/lib/thrift/transport/io_stream_transport.rb +2 -2
- data/lib/thrift/transport/memory_buffer_transport.rb +6 -6
- data/lib/thrift/transport/socket.rb +4 -2
- metadata +4 -2
@@ -1,14 +1,15 @@
|
|
1
1
|
#
|
2
|
-
# Autogenerated by Thrift Compiler (0.
|
2
|
+
# Autogenerated by Thrift Compiler (0.9.0)
|
3
3
|
#
|
4
4
|
# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
|
5
5
|
#
|
6
6
|
|
7
|
+
require 'thrift'
|
7
8
|
require 'note_store_types'
|
8
9
|
|
9
|
-
|
10
|
-
|
11
|
-
|
10
|
+
module Evernote
|
11
|
+
module EDAM
|
12
|
+
module NoteStore
|
12
13
|
end
|
13
14
|
end
|
14
15
|
end
|
@@ -1,9 +1,10 @@
|
|
1
1
|
#
|
2
|
-
# Autogenerated by Thrift Compiler (0.
|
2
|
+
# Autogenerated by Thrift Compiler (0.9.0)
|
3
3
|
#
|
4
4
|
# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
|
5
5
|
#
|
6
6
|
|
7
|
+
require 'thrift'
|
7
8
|
require 'user_store_types'
|
8
9
|
require 'types_types'
|
9
10
|
require 'errors_types'
|
@@ -13,1081 +14,1081 @@ require 'limits_types'
|
|
13
14
|
module Evernote
|
14
15
|
module EDAM
|
15
16
|
module NoteStore
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
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
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
end
|
74
|
-
|
75
|
-
::Thrift::Struct.generate_accessors self
|
76
|
-
end
|
77
|
-
|
78
|
-
# This structure is given out by the NoteStore when a client asks to
|
79
|
-
# receive the current state of an account. The client asks for the server's
|
80
|
-
# state one chunk at a time in order to allow clients to retrieve the state
|
81
|
-
# of a large account without needing to transfer the entire account in
|
82
|
-
# a single message.
|
83
|
-
#
|
84
|
-
# The server always gives SyncChunks using an ascending series of Update
|
85
|
-
# Sequence Numbers (USNs).
|
86
|
-
#
|
87
|
-
# <dl>
|
88
|
-
# <dt>currentTime</dt>
|
89
|
-
# <dd>
|
90
|
-
# The server's current date and time.
|
91
|
-
# </dd>
|
92
|
-
#
|
93
|
-
# <dt>chunkHighUSN</dt>
|
94
|
-
# <dd>
|
95
|
-
# The highest USN for any of the data objects represented
|
96
|
-
# in this sync chunk. If there are no objects in the chunk, this will not be
|
97
|
-
# set.
|
98
|
-
# </dd>
|
99
|
-
#
|
100
|
-
# <dt>updateCount</dt>
|
101
|
-
# <dd>
|
102
|
-
# The total number of updates that have been performed in
|
103
|
-
# the service for this account. This is equal to the highest USN within the
|
104
|
-
# account at the point that this SyncChunk was generated. If updateCount
|
105
|
-
# and chunkHighUSN are identical, that means that this is the last chunk
|
106
|
-
# in the account ... there is no more recent information.
|
107
|
-
# </dd>
|
108
|
-
#
|
109
|
-
# <dt>notes</dt>
|
110
|
-
# <dd>
|
111
|
-
# If present, this is a list of non-expunged notes that
|
112
|
-
# have a USN in this chunk. This will include notes that are "deleted"
|
113
|
-
# but not expunged (i.e. in the trash). The notes will include their list
|
114
|
-
# of tags and resources, but the resource content and recognition data
|
115
|
-
# will not be supplied.
|
116
|
-
# </dd>
|
117
|
-
#
|
118
|
-
# <dt>notebooks</dt>
|
119
|
-
# <dd>
|
120
|
-
# If present, this is a list of non-expunged notebooks that
|
121
|
-
# have a USN in this chunk. This will include notebooks that are "deleted"
|
122
|
-
# but not expunged (i.e. in the trash).
|
123
|
-
# </dd>
|
124
|
-
#
|
125
|
-
# <dt>tags</dt>
|
126
|
-
# <dd>
|
127
|
-
# If present, this is a list of the non-expunged tags that have a
|
128
|
-
# USN in this chunk.
|
129
|
-
# </dd>
|
130
|
-
#
|
131
|
-
# <dt>searches</dt>
|
132
|
-
# <dd>
|
133
|
-
# If present, this is a list of non-expunged searches that
|
134
|
-
# have a USN in this chunk.
|
135
|
-
# </dd>
|
136
|
-
#
|
137
|
-
# <dt>resources</dt>
|
138
|
-
# <dd>
|
139
|
-
# If present, this is a list of the non-expunged resources
|
140
|
-
# that have a USN in this chunk. This will include the metadata for each
|
141
|
-
# resource, but not its binary contents or recognition data, which must be
|
142
|
-
# retrieved separately.
|
143
|
-
# </dd>
|
144
|
-
#
|
145
|
-
# <dt>expungedNotes</dt>
|
146
|
-
# <dd>
|
147
|
-
# If present, the GUIDs of all of the notes that were
|
148
|
-
# permanently expunged in this chunk.
|
149
|
-
# </dd>
|
150
|
-
#
|
151
|
-
# <dt>expungedNotebooks</dt>
|
152
|
-
# <dd>
|
153
|
-
# If present, the GUIDs of all of the notebooks that
|
154
|
-
# were permanently expunged in this chunk. When a notebook is expunged,
|
155
|
-
# this implies that all of its child notes (and their resources) were
|
156
|
-
# also expunged.
|
157
|
-
# </dd>
|
158
|
-
#
|
159
|
-
# <dt>expungedTags</dt>
|
160
|
-
# <dd>
|
161
|
-
# If present, the GUIDs of all of the tags that were
|
162
|
-
# permanently expunged in this chunk.
|
163
|
-
# </dd>
|
164
|
-
#
|
165
|
-
# <dt>expungedSearches</dt>
|
166
|
-
# <dd>
|
167
|
-
# If present, the GUIDs of all of the saved searches
|
168
|
-
# that were permanently expunged in this chunk.
|
169
|
-
# </dd>
|
170
|
-
#
|
171
|
-
# <dt>linkedNotebooks</dt>
|
172
|
-
# <dd>
|
173
|
-
# If present, this is a list of non-expunged LinkedNotebooks that
|
174
|
-
# have a USN in this chunk.
|
175
|
-
# </dd>
|
176
|
-
#
|
177
|
-
# <dt>expungedLinkedNotebooks</dt>
|
178
|
-
# <dd>
|
179
|
-
# If present, the GUIDs of all of the LinkedNotebooks
|
180
|
-
# that were permanently expunged in this chunk.
|
181
|
-
# </dd>
|
182
|
-
# </dl>
|
183
|
-
class SyncChunk
|
184
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
185
|
-
CURRENTTIME = 1
|
186
|
-
CHUNKHIGHUSN = 2
|
187
|
-
UPDATECOUNT = 3
|
188
|
-
NOTES = 4
|
189
|
-
NOTEBOOKS = 5
|
190
|
-
TAGS = 6
|
191
|
-
SEARCHES = 7
|
192
|
-
RESOURCES = 8
|
193
|
-
EXPUNGEDNOTES = 9
|
194
|
-
EXPUNGEDNOTEBOOKS = 10
|
195
|
-
EXPUNGEDTAGS = 11
|
196
|
-
EXPUNGEDSEARCHES = 12
|
197
|
-
LINKEDNOTEBOOKS = 13
|
198
|
-
EXPUNGEDLINKEDNOTEBOOKS = 14
|
199
|
-
|
200
|
-
FIELDS = {
|
201
|
-
CURRENTTIME => {:type => ::Thrift::Types::I64, :name => 'currentTime'},
|
202
|
-
CHUNKHIGHUSN => {:type => ::Thrift::Types::I32, :name => 'chunkHighUSN', :optional => true},
|
203
|
-
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount'},
|
204
|
-
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Note}, :optional => true},
|
205
|
-
NOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'notebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Notebook}, :optional => true},
|
206
|
-
TAGS => {:type => ::Thrift::Types::LIST, :name => 'tags', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Tag}, :optional => true},
|
207
|
-
SEARCHES => {:type => ::Thrift::Types::LIST, :name => 'searches', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::SavedSearch}, :optional => true},
|
208
|
-
RESOURCES => {:type => ::Thrift::Types::LIST, :name => 'resources', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Resource}, :optional => true},
|
209
|
-
EXPUNGEDNOTES => {:type => ::Thrift::Types::LIST, :name => 'expungedNotes', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
210
|
-
EXPUNGEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'expungedNotebooks', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
211
|
-
EXPUNGEDTAGS => {:type => ::Thrift::Types::LIST, :name => 'expungedTags', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
212
|
-
EXPUNGEDSEARCHES => {:type => ::Thrift::Types::LIST, :name => 'expungedSearches', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
213
|
-
LINKEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'linkedNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::LinkedNotebook}, :optional => true},
|
214
|
-
EXPUNGEDLINKEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'expungedLinkedNotebooks', :element => {:type => ::Thrift::Types::STRING}, :optional => true}
|
215
|
-
}
|
216
|
-
|
217
|
-
def struct_fields; FIELDS; end
|
218
|
-
|
219
|
-
def validate
|
220
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field currentTime is unset!') unless @currentTime
|
221
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updateCount is unset!') unless @updateCount
|
222
|
-
end
|
223
|
-
|
224
|
-
::Thrift::Struct.generate_accessors self
|
225
|
-
end
|
226
|
-
|
227
|
-
# This structure is used with the 'getFilteredSyncChunk' call to provide
|
228
|
-
# fine-grained control over the data that's returned when a client needs
|
229
|
-
# to synchronize with the service. Each flag in this structure specifies
|
230
|
-
# whether to include one class of data in the results of that call.
|
231
|
-
#
|
232
|
-
# <dl>
|
233
|
-
# <dt>includeNotes</dt>
|
234
|
-
# <dd>
|
235
|
-
# If true, then the server will include the SyncChunks.notes field
|
236
|
-
# </dd>
|
237
|
-
#
|
238
|
-
# <dt>includeNoteResources</dt>
|
239
|
-
# <dd>
|
240
|
-
# If true, then the server will include the 'resources' field on all of
|
241
|
-
# the Notes that are in SyncChunk.notes.
|
242
|
-
# If 'includeNotes' is false, then this will have no effect.
|
243
|
-
# </dd>
|
244
|
-
#
|
245
|
-
# <dt>includeNoteAttributes</dt>
|
246
|
-
# <dd>
|
247
|
-
# If true, then the server will include the 'attributes' field on all of
|
248
|
-
# the Notes that are in SyncChunks.notes.
|
249
|
-
# If 'includeNotes' is false, then this will have no effect.
|
250
|
-
# </dd>
|
251
|
-
#
|
252
|
-
# <dt>includeNotebooks</dt>
|
253
|
-
# <dd>
|
254
|
-
# If true, then the server will include the SyncChunks.notebooks field
|
255
|
-
# </dd>
|
256
|
-
#
|
257
|
-
# <dt>includeTags</dt>
|
258
|
-
# <dd>
|
259
|
-
# If true, then the server will include the SyncChunks.tags field
|
260
|
-
# </dd>
|
261
|
-
#
|
262
|
-
# <dt>includeSearches</dt>
|
263
|
-
# <dd>
|
264
|
-
# If true, then the server will include the SyncChunks.searches field
|
265
|
-
# </dd>
|
266
|
-
#
|
267
|
-
# <dt>includeResources</dt>
|
268
|
-
# <dd>
|
269
|
-
# If true, then the server will include the SyncChunks.resources field.
|
270
|
-
# Since the Resources are also provided with their Note
|
271
|
-
# (in the Notes.resources list), this is primarily useful for clients that
|
272
|
-
# want to watch for changes to individual Resources due to recognition data
|
273
|
-
# being added.
|
274
|
-
# </dd>
|
275
|
-
#
|
276
|
-
# <dt>includeLinkedNotebooks</dt>
|
277
|
-
# <dd>
|
278
|
-
# If true, then the server will include the SyncChunks.linkedNotebooks field.
|
279
|
-
# </dd>
|
280
|
-
#
|
281
|
-
# <dt>includeExpunged</dt>
|
282
|
-
# <dd>
|
283
|
-
# If true, then the server will include the 'expunged' data for any type
|
284
|
-
# of included data. For example, if 'includeTags' and 'includeExpunged'
|
285
|
-
# are both true, then the SyncChunks.expungedTags field will be set with
|
286
|
-
# the GUIDs of tags that have been expunged from the server.
|
287
|
-
# </dd>
|
288
|
-
#
|
289
|
-
# <dt>includeNoteApplicationDataFullMap</dt>
|
290
|
-
# <dd>
|
291
|
-
# If true, then the values for the applicationData map will be filled
|
292
|
-
# in, assuming notes and note attributes are being returned. Otherwise,
|
293
|
-
# only the keysOnly field will be filled in.
|
294
|
-
# </dd>
|
295
|
-
#
|
296
|
-
# <dt>includeResourceApplicationDataFullMap</dt>
|
297
|
-
# <dd>
|
298
|
-
# If true, then the fullMap values for the applicationData map will be
|
299
|
-
# filled in, assuming resources and resource attributes are being returned
|
300
|
-
# (includeResources is true). Otherwise, only the keysOnly field will be
|
301
|
-
# filled in.
|
302
|
-
# </dd>
|
303
|
-
#
|
304
|
-
# <dt>includeNoteResourceApplicationDataFullMap</dt>
|
305
|
-
# <dd>
|
306
|
-
# If true, then the fullMap values for the applicationData map will be
|
307
|
-
# filled in for resources found inside of notes, assuming resources are
|
308
|
-
# being returned in notes (includeNoteResources is true). Otherwise,
|
309
|
-
# only the keysOnly field will be filled in.
|
310
|
-
# </dd>
|
311
|
-
#
|
312
|
-
# <dt>requireNoteContentClass</dt>
|
313
|
-
# <dd>
|
314
|
-
# If set, then only send notes whose content class matches this value.
|
315
|
-
# The value can be a literal match or, if the last character is an
|
316
|
-
# asterisk, a prefix match.
|
317
|
-
# </dd>
|
318
|
-
# </dl>
|
319
|
-
class SyncChunkFilter
|
320
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
321
|
-
INCLUDENOTES = 1
|
322
|
-
INCLUDENOTERESOURCES = 2
|
323
|
-
INCLUDENOTEATTRIBUTES = 3
|
324
|
-
INCLUDENOTEBOOKS = 4
|
325
|
-
INCLUDETAGS = 5
|
326
|
-
INCLUDESEARCHES = 6
|
327
|
-
INCLUDERESOURCES = 7
|
328
|
-
INCLUDELINKEDNOTEBOOKS = 8
|
329
|
-
INCLUDEEXPUNGED = 9
|
330
|
-
INCLUDENOTEAPPLICATIONDATAFULLMAP = 10
|
331
|
-
INCLUDERESOURCEAPPLICATIONDATAFULLMAP = 12
|
332
|
-
INCLUDENOTERESOURCEAPPLICATIONDATAFULLMAP = 13
|
333
|
-
REQUIRENOTECONTENTCLASS = 11
|
334
|
-
|
335
|
-
FIELDS = {
|
336
|
-
INCLUDENOTES => {:type => ::Thrift::Types::BOOL, :name => 'includeNotes', :optional => true},
|
337
|
-
INCLUDENOTERESOURCES => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteResources', :optional => true},
|
338
|
-
INCLUDENOTEATTRIBUTES => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteAttributes', :optional => true},
|
339
|
-
INCLUDENOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeNotebooks', :optional => true},
|
340
|
-
INCLUDETAGS => {:type => ::Thrift::Types::BOOL, :name => 'includeTags', :optional => true},
|
341
|
-
INCLUDESEARCHES => {:type => ::Thrift::Types::BOOL, :name => 'includeSearches', :optional => true},
|
342
|
-
INCLUDERESOURCES => {:type => ::Thrift::Types::BOOL, :name => 'includeResources', :optional => true},
|
343
|
-
INCLUDELINKEDNOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeLinkedNotebooks', :optional => true},
|
344
|
-
INCLUDEEXPUNGED => {:type => ::Thrift::Types::BOOL, :name => 'includeExpunged', :optional => true},
|
345
|
-
INCLUDENOTEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteApplicationDataFullMap', :optional => true},
|
346
|
-
INCLUDERESOURCEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeResourceApplicationDataFullMap', :optional => true},
|
347
|
-
INCLUDENOTERESOURCEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteResourceApplicationDataFullMap', :optional => true},
|
348
|
-
REQUIRENOTECONTENTCLASS => {:type => ::Thrift::Types::STRING, :name => 'requireNoteContentClass', :optional => true}
|
349
|
-
}
|
350
|
-
|
351
|
-
def struct_fields; FIELDS; end
|
352
|
-
|
353
|
-
def validate
|
354
|
-
end
|
355
|
-
|
356
|
-
::Thrift::Struct.generate_accessors self
|
357
|
-
end
|
358
|
-
|
359
|
-
# A list of criteria that are used to indicate which notes are desired from
|
360
|
-
# the account. This is used in queries to the NoteStore to determine
|
361
|
-
# which notes should be retrieved.
|
362
|
-
#
|
363
|
-
# <dl>
|
364
|
-
# <dt>order</dt>
|
365
|
-
# <dd>
|
366
|
-
# The NoteSortOrder value indicating what criterion should be
|
367
|
-
# used to sort the results of the filter.
|
368
|
-
# </dd>
|
369
|
-
#
|
370
|
-
# <dt>ascending</dt>
|
371
|
-
# <dd>
|
372
|
-
# If true, the results will be ascending in the requested
|
373
|
-
# sort order. If false, the results will be descending.
|
374
|
-
# </dd>
|
375
|
-
#
|
376
|
-
# <dt>words</dt>
|
377
|
-
# <dd>
|
378
|
-
# If present, a search query string that will filter the set of notes to be returned.
|
379
|
-
# Accepts the full search grammar documented in the Evernote API Overview.
|
380
|
-
# </dd>
|
381
|
-
#
|
382
|
-
# <dt>notebookGuid</dt>
|
383
|
-
# <dd>
|
384
|
-
# If present, the Guid of the notebook that must contain
|
385
|
-
# the notes.
|
386
|
-
# </dd>
|
387
|
-
#
|
388
|
-
# <dt>tagGuids</dt>
|
389
|
-
# <dd>
|
390
|
-
# If present, the list of tags (by GUID) that must be present
|
391
|
-
# on the notes.
|
392
|
-
# </dd>
|
393
|
-
#
|
394
|
-
# <dt>timeZone</dt>
|
395
|
-
# <dd>
|
396
|
-
# The zone ID for the user, which will be used to interpret
|
397
|
-
# any dates or times in the queries that do not include their desired zone
|
398
|
-
# information.
|
399
|
-
# For example, if a query requests notes created "yesterday", this
|
400
|
-
# will be evaluated from the provided time zone, if provided.
|
401
|
-
# The format must be encoded as a standard zone ID such as
|
402
|
-
# "America/Los_Angeles".
|
403
|
-
# </dd>
|
404
|
-
#
|
405
|
-
# <dt>inactive</dt>
|
406
|
-
# <dd>
|
407
|
-
# If true, then only notes that are not active (i.e. notes in
|
408
|
-
# the Trash) will be returned. Otherwise, only active notes will be returned.
|
409
|
-
# There is no way to find both active and inactive notes in a single query.
|
410
|
-
# </dd>
|
411
|
-
#
|
412
|
-
# <dt>emphasized</dt>
|
413
|
-
# <dd>
|
414
|
-
# If present, a search query string that may or may not influence the notes
|
415
|
-
# to be returned, both in terms of coverage as well as of order. Think of it
|
416
|
-
# as a wish list, not a requirement.
|
417
|
-
# Accepts the full search grammar documented in the Evernote API Overview.
|
418
|
-
# </dd>
|
419
|
-
# </dl>
|
420
|
-
class NoteFilter
|
421
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
422
|
-
ORDER = 1
|
423
|
-
ASCENDING = 2
|
424
|
-
WORDS = 3
|
425
|
-
NOTEBOOKGUID = 4
|
426
|
-
TAGGUIDS = 5
|
427
|
-
TIMEZONE = 6
|
428
|
-
INACTIVE = 7
|
429
|
-
EMPHASIZED = 8
|
430
|
-
|
431
|
-
FIELDS = {
|
432
|
-
ORDER => {:type => ::Thrift::Types::I32, :name => 'order', :optional => true},
|
433
|
-
ASCENDING => {:type => ::Thrift::Types::BOOL, :name => 'ascending', :optional => true},
|
434
|
-
WORDS => {:type => ::Thrift::Types::STRING, :name => 'words', :optional => true},
|
435
|
-
NOTEBOOKGUID => {:type => ::Thrift::Types::STRING, :name => 'notebookGuid', :optional => true},
|
436
|
-
TAGGUIDS => {:type => ::Thrift::Types::LIST, :name => 'tagGuids', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
437
|
-
TIMEZONE => {:type => ::Thrift::Types::STRING, :name => 'timeZone', :optional => true},
|
438
|
-
INACTIVE => {:type => ::Thrift::Types::BOOL, :name => 'inactive', :optional => true},
|
439
|
-
EMPHASIZED => {:type => ::Thrift::Types::STRING, :name => 'emphasized', :optional => true}
|
440
|
-
}
|
441
|
-
|
442
|
-
def struct_fields; FIELDS; end
|
443
|
-
|
444
|
-
def validate
|
445
|
-
end
|
446
|
-
|
447
|
-
::Thrift::Struct.generate_accessors self
|
448
|
-
end
|
449
|
-
|
450
|
-
# A small structure for returning a list of notes out of a larger set.
|
451
|
-
#
|
452
|
-
# <dl>
|
453
|
-
# <dt>startIndex</dt>
|
454
|
-
# <dd>
|
455
|
-
# The starting index within the overall set of notes. This
|
456
|
-
# is also the number of notes that are "before" this list in the set.
|
457
|
-
# </dd>
|
458
|
-
#
|
459
|
-
# <dt>totalNotes</dt>
|
460
|
-
# <dd>
|
461
|
-
# The number of notes in the larger set. This can be used
|
462
|
-
# to calculate how many notes are "after" this note in the set.
|
463
|
-
# (I.e. remaining = totalNotes - (startIndex + notes.length) )
|
464
|
-
# </dd>
|
465
|
-
#
|
466
|
-
# <dt>notes</dt>
|
467
|
-
# <dd>
|
468
|
-
# The list of notes from this range. The Notes will include all
|
469
|
-
# metadata (attributes, resources, etc.), but will not include the ENML
|
470
|
-
# content of the note or the binary contents of any resources.
|
471
|
-
# </dd>
|
472
|
-
#
|
473
|
-
# <dt>stoppedWords</dt>
|
474
|
-
# <dd>
|
475
|
-
# If the NoteList was produced using a text based search
|
476
|
-
# query that included words that are not indexed or searched by the service,
|
477
|
-
# this will include a list of those ignored words.
|
478
|
-
# </dd>
|
479
|
-
#
|
480
|
-
# <dt>searchedWords</dt>
|
481
|
-
# <dd>
|
482
|
-
# If the NoteList was produced using a text based search
|
483
|
-
# query that included viable search words or quoted expressions, this will
|
484
|
-
# include a list of those words. Any stopped words will not be included
|
485
|
-
# in this list.
|
486
|
-
# </dd>
|
487
|
-
#
|
488
|
-
# <dt>updateCount</dt>
|
489
|
-
# <dd>
|
490
|
-
# Indicates the total number of transactions that have
|
491
|
-
# been committed within the account. This reflects (for example) the
|
492
|
-
# number of discrete additions or modifications that have been made to
|
493
|
-
# the data in this account (tags, notes, resources, etc.).
|
494
|
-
# This number is the "high water mark" for Update Sequence Numbers (USN)
|
495
|
-
# within the account.
|
496
|
-
# </dd>
|
497
|
-
# </dl>
|
498
|
-
class NoteList
|
499
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
500
|
-
STARTINDEX = 1
|
501
|
-
TOTALNOTES = 2
|
502
|
-
NOTES = 3
|
503
|
-
STOPPEDWORDS = 4
|
504
|
-
SEARCHEDWORDS = 5
|
505
|
-
UPDATECOUNT = 6
|
506
|
-
|
507
|
-
FIELDS = {
|
508
|
-
STARTINDEX => {:type => ::Thrift::Types::I32, :name => 'startIndex'},
|
509
|
-
TOTALNOTES => {:type => ::Thrift::Types::I32, :name => 'totalNotes'},
|
510
|
-
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Note}},
|
511
|
-
STOPPEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'stoppedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
512
|
-
SEARCHEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'searchedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
513
|
-
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount', :optional => true}
|
514
|
-
}
|
515
|
-
|
516
|
-
def struct_fields; FIELDS; end
|
517
|
-
|
518
|
-
def validate
|
519
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field startIndex is unset!') unless @startIndex
|
520
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field totalNotes is unset!') unless @totalNotes
|
521
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field notes is unset!') unless @notes
|
522
|
-
end
|
523
|
-
|
524
|
-
::Thrift::Struct.generate_accessors self
|
525
|
-
end
|
526
|
-
|
527
|
-
# This structure is used in the set of results returned by the
|
528
|
-
# findNotesMetadata function. It represents the high-level information about
|
529
|
-
# a single Note, without some of the larger deep structure. This allows
|
530
|
-
# for the information about a list of Notes to be returned relatively quickly
|
531
|
-
# with less marshalling and data transfer to remote clients.
|
532
|
-
# Most fields in this structure are identical to the corresponding field in
|
533
|
-
# the Note structure, with the exception of:
|
534
|
-
#
|
535
|
-
# <dl>
|
536
|
-
# <dt>largestResourceMime</dt>
|
537
|
-
# <dd>If set, then this will contain the MIME type of the largest Resource
|
538
|
-
# (in bytes) within the Note. This may be useful, for example, to choose
|
539
|
-
# an appropriate icon or thumbnail to represent the Note.
|
540
|
-
# </dd>
|
541
|
-
#
|
542
|
-
# <dt>largestResourceSize</dt>
|
543
|
-
# <dd>If set, this will contain the size of the largest Resource file, in
|
544
|
-
# bytes, within the Note. This may be useful, for example, to decide whether
|
545
|
-
# to ask the server for a thumbnail to represent the Note.
|
546
|
-
# </dd>
|
547
|
-
# </dl>
|
548
|
-
class NoteMetadata
|
549
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
550
|
-
GUID = 1
|
551
|
-
TITLE = 2
|
552
|
-
CONTENTLENGTH = 5
|
553
|
-
CREATED = 6
|
554
|
-
UPDATED = 7
|
555
|
-
UPDATESEQUENCENUM = 10
|
556
|
-
NOTEBOOKGUID = 11
|
557
|
-
TAGGUIDS = 12
|
558
|
-
ATTRIBUTES = 14
|
559
|
-
LARGESTRESOURCEMIME = 20
|
560
|
-
LARGESTRESOURCESIZE = 21
|
561
|
-
|
562
|
-
FIELDS = {
|
563
|
-
GUID => {:type => ::Thrift::Types::STRING, :name => 'guid'},
|
564
|
-
TITLE => {:type => ::Thrift::Types::STRING, :name => 'title', :optional => true},
|
565
|
-
CONTENTLENGTH => {:type => ::Thrift::Types::I32, :name => 'contentLength', :optional => true},
|
566
|
-
CREATED => {:type => ::Thrift::Types::I64, :name => 'created', :optional => true},
|
567
|
-
UPDATED => {:type => ::Thrift::Types::I64, :name => 'updated', :optional => true},
|
568
|
-
UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum', :optional => true},
|
569
|
-
NOTEBOOKGUID => {:type => ::Thrift::Types::STRING, :name => 'notebookGuid', :optional => true},
|
570
|
-
TAGGUIDS => {:type => ::Thrift::Types::LIST, :name => 'tagGuids', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
571
|
-
ATTRIBUTES => {:type => ::Thrift::Types::STRUCT, :name => 'attributes', :class => Evernote::EDAM::Type::NoteAttributes, :optional => true},
|
572
|
-
LARGESTRESOURCEMIME => {:type => ::Thrift::Types::STRING, :name => 'largestResourceMime', :optional => true},
|
573
|
-
LARGESTRESOURCESIZE => {:type => ::Thrift::Types::I32, :name => 'largestResourceSize', :optional => true}
|
574
|
-
}
|
575
|
-
|
576
|
-
def struct_fields; FIELDS; end
|
577
|
-
|
578
|
-
def validate
|
579
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field guid is unset!') unless @guid
|
580
|
-
end
|
581
|
-
|
582
|
-
::Thrift::Struct.generate_accessors self
|
583
|
-
end
|
584
|
-
|
585
|
-
# This structure is returned from calls to the findNotesMetadata function to
|
586
|
-
# give the high-level metadata about a subset of Notes that are found to
|
587
|
-
# match a specified NoteFilter in a search.
|
588
|
-
#
|
589
|
-
# <dl>
|
590
|
-
# <dt>startIndex</dt>
|
591
|
-
# <dd>
|
592
|
-
# The starting index within the overall set of notes. This
|
593
|
-
# is also the number of notes that are "before" this list in the set.
|
594
|
-
# </dd>
|
595
|
-
#
|
596
|
-
# <dt>totalNotes</dt>
|
597
|
-
# <dd>
|
598
|
-
# The number of notes in the larger set. This can be used
|
599
|
-
# to calculate how many notes are "after" this note in the set.
|
600
|
-
# (I.e. remaining = totalNotes - (startIndex + notes.length) )
|
601
|
-
# </dd>
|
602
|
-
#
|
603
|
-
# <dt>notes</dt>
|
604
|
-
# <dd>
|
605
|
-
# The list of metadata for Notes in this range. The set of optional fields
|
606
|
-
# that are set in each metadata structure will depend on the
|
607
|
-
# NotesMetadataResultSpec provided by the caller when the search was
|
608
|
-
# performed. Only the 'guid' field will be guaranteed to be set in each
|
609
|
-
# Note.
|
610
|
-
# </dd>
|
611
|
-
#
|
612
|
-
# <dt>stoppedWords</dt>
|
613
|
-
# <dd>
|
614
|
-
# If the NoteList was produced using a text based search
|
615
|
-
# query that included words that are not indexed or searched by the service,
|
616
|
-
# this will include a list of those ignored words.
|
617
|
-
# </dd>
|
618
|
-
#
|
619
|
-
# <dt>searchedWords</dt>
|
620
|
-
# <dd>
|
621
|
-
# If the NoteList was produced using a text based search
|
622
|
-
# query that included viable search words or quoted expressions, this will
|
623
|
-
# include a list of those words. Any stopped words will not be included
|
624
|
-
# in this list.
|
625
|
-
# </dd>
|
626
|
-
#
|
627
|
-
# <dt>updateCount</dt>
|
628
|
-
# <dd>
|
629
|
-
# Indicates the total number of transactions that have
|
630
|
-
# been committed within the account. This reflects (for example) the
|
631
|
-
# number of discrete additions or modifications that have been made to
|
632
|
-
# the data in this account (tags, notes, resources, etc.).
|
633
|
-
# This number is the "high water mark" for Update Sequence Numbers (USN)
|
634
|
-
# within the account.
|
635
|
-
# </dd>
|
636
|
-
# </dl>
|
637
|
-
class NotesMetadataList
|
638
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
639
|
-
STARTINDEX = 1
|
640
|
-
TOTALNOTES = 2
|
641
|
-
NOTES = 3
|
642
|
-
STOPPEDWORDS = 4
|
643
|
-
SEARCHEDWORDS = 5
|
644
|
-
UPDATECOUNT = 6
|
645
|
-
|
646
|
-
FIELDS = {
|
647
|
-
STARTINDEX => {:type => ::Thrift::Types::I32, :name => 'startIndex'},
|
648
|
-
TOTALNOTES => {:type => ::Thrift::Types::I32, :name => 'totalNotes'},
|
649
|
-
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::NoteStore::NoteMetadata}},
|
650
|
-
STOPPEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'stoppedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
651
|
-
SEARCHEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'searchedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
652
|
-
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount', :optional => true}
|
653
|
-
}
|
654
|
-
|
655
|
-
def struct_fields; FIELDS; end
|
656
|
-
|
657
|
-
def validate
|
658
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field startIndex is unset!') unless @startIndex
|
659
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field totalNotes is unset!') unless @totalNotes
|
660
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field notes is unset!') unless @notes
|
661
|
-
end
|
662
|
-
|
663
|
-
::Thrift::Struct.generate_accessors self
|
664
|
-
end
|
665
|
-
|
666
|
-
# This structure is provided to the findNotesMetadata function to specify
|
667
|
-
# the subset of fields that should be included in each NoteMetadata element
|
668
|
-
# that is returned in the NotesMetadataList.
|
669
|
-
# Each field on this structure is a boolean flag that indicates whether the
|
670
|
-
# corresponding field should be included in the NoteMetadata structure when
|
671
|
-
# it is returned. For example, if the 'includeTitle' field is set on this
|
672
|
-
# structure when calling findNotesMetadata, then each NoteMetadata in the
|
673
|
-
# list should have its 'title' field set.
|
674
|
-
# If one of the fields in this spec is not set, then it will be treated as
|
675
|
-
# 'false' by the server, so the default behavior is to include nothing in
|
676
|
-
# replies (but the mandatory GUID)
|
677
|
-
class NotesMetadataResultSpec
|
678
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
679
|
-
INCLUDETITLE = 2
|
680
|
-
INCLUDECONTENTLENGTH = 5
|
681
|
-
INCLUDECREATED = 6
|
682
|
-
INCLUDEUPDATED = 7
|
683
|
-
INCLUDEUPDATESEQUENCENUM = 10
|
684
|
-
INCLUDENOTEBOOKGUID = 11
|
685
|
-
INCLUDETAGGUIDS = 12
|
686
|
-
INCLUDEATTRIBUTES = 14
|
687
|
-
INCLUDELARGESTRESOURCEMIME = 20
|
688
|
-
INCLUDELARGESTRESOURCESIZE = 21
|
689
|
-
|
690
|
-
FIELDS = {
|
691
|
-
INCLUDETITLE => {:type => ::Thrift::Types::BOOL, :name => 'includeTitle', :optional => true},
|
692
|
-
INCLUDECONTENTLENGTH => {:type => ::Thrift::Types::BOOL, :name => 'includeContentLength', :optional => true},
|
693
|
-
INCLUDECREATED => {:type => ::Thrift::Types::BOOL, :name => 'includeCreated', :optional => true},
|
694
|
-
INCLUDEUPDATED => {:type => ::Thrift::Types::BOOL, :name => 'includeUpdated', :optional => true},
|
695
|
-
INCLUDEUPDATESEQUENCENUM => {:type => ::Thrift::Types::BOOL, :name => 'includeUpdateSequenceNum', :optional => true},
|
696
|
-
INCLUDENOTEBOOKGUID => {:type => ::Thrift::Types::BOOL, :name => 'includeNotebookGuid', :optional => true},
|
697
|
-
INCLUDETAGGUIDS => {:type => ::Thrift::Types::BOOL, :name => 'includeTagGuids', :optional => true},
|
698
|
-
INCLUDEATTRIBUTES => {:type => ::Thrift::Types::BOOL, :name => 'includeAttributes', :optional => true},
|
699
|
-
INCLUDELARGESTRESOURCEMIME => {:type => ::Thrift::Types::BOOL, :name => 'includeLargestResourceMime', :optional => true},
|
700
|
-
INCLUDELARGESTRESOURCESIZE => {:type => ::Thrift::Types::BOOL, :name => 'includeLargestResourceSize', :optional => true}
|
701
|
-
}
|
702
|
-
|
703
|
-
def struct_fields; FIELDS; end
|
704
|
-
|
705
|
-
def validate
|
706
|
-
end
|
707
|
-
|
708
|
-
::Thrift::Struct.generate_accessors self
|
709
|
-
end
|
710
|
-
|
711
|
-
# A data structure representing the number of notes for each notebook
|
712
|
-
# and tag with a non-zero set of applicable notes.
|
713
|
-
#
|
714
|
-
# <dl>
|
715
|
-
# <dt>notebookCounts</dt>
|
716
|
-
# <dd>
|
717
|
-
# A mapping from the Notebook GUID to the number of
|
718
|
-
# notes (from some selection) that are in the corresponding notebook.
|
719
|
-
# </dd>
|
720
|
-
#
|
721
|
-
# <dt>tagCounts</dt>
|
722
|
-
# <dd>
|
723
|
-
# A mapping from the Tag GUID to the number of notes (from some
|
724
|
-
# selection) that have the corresponding tag.
|
725
|
-
# </dd>
|
726
|
-
#
|
727
|
-
# <dt>trashCount</dt>
|
728
|
-
# <dd>
|
729
|
-
# If this is set, then this is the number of notes that are in the trash.
|
730
|
-
# If this is not set, then the number of notes in the trash hasn't been
|
731
|
-
# reported. (I.e. if there are no notes in the trash, this will be set
|
732
|
-
# to 0.)
|
733
|
-
# </dd>
|
734
|
-
# </dl>
|
735
|
-
class NoteCollectionCounts
|
736
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
737
|
-
NOTEBOOKCOUNTS = 1
|
738
|
-
TAGCOUNTS = 2
|
739
|
-
TRASHCOUNT = 3
|
740
|
-
|
741
|
-
FIELDS = {
|
742
|
-
NOTEBOOKCOUNTS => {:type => ::Thrift::Types::MAP, :name => 'notebookCounts', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::I32}, :optional => true},
|
743
|
-
TAGCOUNTS => {:type => ::Thrift::Types::MAP, :name => 'tagCounts', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::I32}, :optional => true},
|
744
|
-
TRASHCOUNT => {:type => ::Thrift::Types::I32, :name => 'trashCount', :optional => true}
|
745
|
-
}
|
746
|
-
|
747
|
-
def struct_fields; FIELDS; end
|
748
|
-
|
749
|
-
def validate
|
750
|
-
end
|
751
|
-
|
752
|
-
::Thrift::Struct.generate_accessors self
|
753
|
-
end
|
754
|
-
|
755
|
-
# Parameters that must be given to the NoteStore emailNote call. These allow
|
756
|
-
# the caller to specify the note to send, the recipient addresses, etc.
|
757
|
-
#
|
758
|
-
# <dl>
|
759
|
-
# <dt>guid</dt>
|
760
|
-
# <dd>
|
761
|
-
# If set, this must be the GUID of a note within the user's account that
|
762
|
-
# should be retrieved from the service and sent as email. If not set,
|
763
|
-
# the 'note' field must be provided instead.
|
764
|
-
# </dd>
|
765
|
-
#
|
766
|
-
# <dt>note</dt>
|
767
|
-
# <dd>
|
768
|
-
# If the 'guid' field is not set, this field must be provided, including
|
769
|
-
# the full contents of the note note (and all of its Resources) to send.
|
770
|
-
# This can be used for a Note that as not been created in the service,
|
771
|
-
# for example by a local client with local notes.
|
772
|
-
# </dd>
|
773
|
-
#
|
774
|
-
# <dt>toAddresses</dt>
|
775
|
-
# <dd>
|
776
|
-
# If provided, this should contain a list of the SMTP email addresses
|
777
|
-
# that should be included in the "To:" line of the email.
|
778
|
-
# Callers must specify at least one "to" or "cc" email address.
|
779
|
-
# </dd>
|
780
|
-
#
|
781
|
-
# <dt>ccAddresses</dt>
|
782
|
-
# <dd>
|
783
|
-
# If provided, this should contain a list of the SMTP email addresses
|
784
|
-
# that should be included in the "Cc:" line of the email.
|
785
|
-
# Callers must specify at least one "to" or "cc" email address.
|
786
|
-
# </dd>
|
787
|
-
#
|
788
|
-
# <dt>subject</dt>
|
789
|
-
# <dd>
|
790
|
-
# If provided, this should contain the subject line of the email that
|
791
|
-
# will be sent. If not provided, the title of the note will be used
|
792
|
-
# as the subject of the email.
|
793
|
-
# </dd>
|
794
|
-
#
|
795
|
-
# <dt>message</dt>
|
796
|
-
# <dd>
|
797
|
-
# If provided, this is additional personal text that should be included
|
798
|
-
# into the email as a message from the owner to the recipient(s).
|
799
|
-
# </dd>
|
800
|
-
# </dl>
|
801
|
-
class NoteEmailParameters
|
802
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
803
|
-
GUID = 1
|
804
|
-
NOTE = 2
|
805
|
-
TOADDRESSES = 3
|
806
|
-
CCADDRESSES = 4
|
807
|
-
SUBJECT = 5
|
808
|
-
MESSAGE = 6
|
809
|
-
|
810
|
-
FIELDS = {
|
811
|
-
GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true},
|
812
|
-
NOTE => {:type => ::Thrift::Types::STRUCT, :name => 'note', :class => Evernote::EDAM::Type::Note, :optional => true},
|
813
|
-
TOADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'toAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
814
|
-
CCADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'ccAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
815
|
-
SUBJECT => {:type => ::Thrift::Types::STRING, :name => 'subject', :optional => true},
|
816
|
-
MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message', :optional => true}
|
817
|
-
}
|
818
|
-
|
819
|
-
def struct_fields; FIELDS; end
|
820
|
-
|
821
|
-
def validate
|
822
|
-
end
|
823
|
-
|
824
|
-
::Thrift::Struct.generate_accessors self
|
825
|
-
end
|
826
|
-
|
827
|
-
# Identifying information about previous versions of a note that are backed up
|
828
|
-
# within Evernote's servers. Used in the return value of the listNoteVersions
|
829
|
-
# call.
|
830
|
-
#
|
831
|
-
# <dl>
|
832
|
-
# <dt>updateSequenceNum</dt>
|
833
|
-
# <dd>
|
834
|
-
# The update sequence number for the Note when it last had this content.
|
835
|
-
# This serves to uniquely identify each version of the note, since USN
|
836
|
-
# values are unique within an account for each update.
|
837
|
-
# </dd>
|
838
|
-
# <dt>updated</dt>
|
839
|
-
# <dd>
|
840
|
-
# The 'updated' time that was set on the Note when it had this version
|
841
|
-
# of the content. This is the user-modifiable modification time on the
|
842
|
-
# note, so it's not reliable for guaranteeing the order of various
|
843
|
-
# versions. (E.g. if someone modifies the note, then changes this time
|
844
|
-
# manually into the past and then updates the note again.)
|
845
|
-
# </dd>
|
846
|
-
# <dt>saved</dt>
|
847
|
-
# <dd>
|
848
|
-
# A timestamp that holds the date and time when this version of the note
|
849
|
-
# was backed up by Evernote's servers. This
|
850
|
-
# </dd>
|
851
|
-
# <dt>title</dt>
|
852
|
-
# <dd>
|
853
|
-
# The title of the note when this particular version was saved. (The
|
854
|
-
# current title of the note may differ from this value.)
|
855
|
-
# </dd>
|
856
|
-
# </dl>
|
857
|
-
class NoteVersionId
|
858
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
859
|
-
UPDATESEQUENCENUM = 1
|
860
|
-
UPDATED = 2
|
861
|
-
SAVED = 3
|
862
|
-
TITLE = 4
|
863
|
-
|
864
|
-
FIELDS = {
|
865
|
-
UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum'},
|
866
|
-
UPDATED => {:type => ::Thrift::Types::I64, :name => 'updated'},
|
867
|
-
SAVED => {:type => ::Thrift::Types::I64, :name => 'saved'},
|
868
|
-
TITLE => {:type => ::Thrift::Types::STRING, :name => 'title'}
|
869
|
-
}
|
870
|
-
|
871
|
-
def struct_fields; FIELDS; end
|
872
|
-
|
873
|
-
def validate
|
874
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updateSequenceNum is unset!') unless @updateSequenceNum
|
875
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updated is unset!') unless @updated
|
876
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field saved is unset!') unless @saved
|
877
|
-
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field title is unset!') unless @title
|
878
|
-
end
|
879
|
-
|
880
|
-
::Thrift::Struct.generate_accessors self
|
881
|
-
end
|
882
|
-
|
883
|
-
# This structure is passed from clients to the Evernote service when they wish
|
884
|
-
# to relay coarse-grained usage metrics to the service to help improve
|
885
|
-
# products.
|
886
|
-
#
|
887
|
-
# <dl>
|
888
|
-
# <dt>sessions</dt>
|
889
|
-
# <dd>
|
890
|
-
# This field contains a count of the number of usage "sessions" that have
|
891
|
-
# occurred with this client which have not previously been reported to
|
892
|
-
# the service.
|
893
|
-
# A "session" is defined as one of the 96 fifteen-minute intervals of the
|
894
|
-
# day when someone used Evernote's interface at least once.
|
895
|
-
# So if a user interacts with an Evernote client at 12:18, 12:24, and 12:36,
|
896
|
-
# and then the client synchronizes at 12:39, it would report that there were
|
897
|
-
# two previously-unreported sessions (one session for the 12:15-12:30 time
|
898
|
-
# period, and one for the 12:30-12:45 period).
|
899
|
-
# If the user used Evernote again at 12:41 and synchronized at 12:43, it
|
900
|
-
# would not report any new sessions, because the 12:30-12:45 session had
|
901
|
-
# already been reported.
|
902
|
-
# </dd>
|
903
|
-
# </dl>
|
904
|
-
class ClientUsageMetrics
|
905
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
906
|
-
SESSIONS = 1
|
907
|
-
|
908
|
-
FIELDS = {
|
909
|
-
SESSIONS => {:type => ::Thrift::Types::I32, :name => 'sessions', :optional => true}
|
910
|
-
}
|
911
|
-
|
912
|
-
def struct_fields; FIELDS; end
|
913
|
-
|
914
|
-
def validate
|
915
|
-
end
|
916
|
-
|
917
|
-
::Thrift::Struct.generate_accessors self
|
918
|
-
end
|
919
|
-
|
920
|
-
# A description of the thing for which we are searching for related
|
921
|
-
# entities.
|
922
|
-
#
|
923
|
-
# You must specify either <em>noteGuid</em> or <em>plainText</em>, but
|
924
|
-
# not both. <em>filter</em> is optional.
|
925
|
-
#
|
926
|
-
# <dl>
|
927
|
-
# <dt>noteGuid</dt>
|
928
|
-
# <dd>The GUID of an existing note in your account for which related
|
929
|
-
# entities will be found.</dd>
|
930
|
-
#
|
931
|
-
# <dt>plainText</dt>
|
932
|
-
# <dd>A string of plain text for which to find related entities.
|
933
|
-
# You should provide a text block with a number of characters between
|
934
|
-
# EDAM_RELATED_PLAINTEXT_LEN_MIN and EDAM_RELATED_PLAINTEXT_LEN_MAX.
|
935
|
-
# </dd>
|
936
|
-
#
|
937
|
-
# <dt>filter</dt>
|
938
|
-
# <dd>The list of criteria that will constrain the notes being considered
|
939
|
-
# related.
|
940
|
-
# Please note that some of the parameters may be ignored, such as
|
941
|
-
# <em>order</em> and <em>ascending</em>.
|
942
|
-
# </dd>
|
943
|
-
# </dl>
|
944
|
-
class RelatedQuery
|
945
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
946
|
-
NOTEGUID = 1
|
947
|
-
PLAINTEXT = 2
|
948
|
-
FILTER = 3
|
949
|
-
|
950
|
-
FIELDS = {
|
951
|
-
NOTEGUID => {:type => ::Thrift::Types::STRING, :name => 'noteGuid', :optional => true},
|
952
|
-
PLAINTEXT => {:type => ::Thrift::Types::STRING, :name => 'plainText', :optional => true},
|
953
|
-
FILTER => {:type => ::Thrift::Types::STRUCT, :name => 'filter', :class => Evernote::EDAM::NoteStore::NoteFilter, :optional => true}
|
954
|
-
}
|
955
|
-
|
956
|
-
def struct_fields; FIELDS; end
|
957
|
-
|
958
|
-
def validate
|
959
|
-
end
|
960
|
-
|
961
|
-
::Thrift::Struct.generate_accessors self
|
962
|
-
end
|
963
|
-
|
964
|
-
# The result of calling findRelated(). The contents of the notes,
|
965
|
-
# notebooks, and tags fields will be in decreasing order of expected
|
966
|
-
# relevance. It is possible that fewer results than requested will be
|
967
|
-
# returned even if there are enough distinct entities in the account
|
968
|
-
# in cases where the relevance is estimated to be low.
|
969
|
-
#
|
970
|
-
# <dl>
|
971
|
-
# <dt>notes</dt>
|
972
|
-
# <dd>If notes have been requested to be included, this will be the
|
973
|
-
# list of notes.</dd>
|
974
|
-
#
|
975
|
-
# <dt>notebooks</dt>
|
976
|
-
# <dd>If notebooks have been requested to be included, this will be the
|
977
|
-
# list of notebooks.</dd>
|
978
|
-
#
|
979
|
-
# <dt>tags</dt>
|
980
|
-
# <dd>If tags have been requested to be included, this will be the list
|
981
|
-
# of tags.</dd>
|
982
|
-
# </dl>
|
983
|
-
#
|
984
|
-
# <dt>containingNotebooks</dt>
|
985
|
-
# <dd>If <code>includeContainingNotebooks</code> is set to <code>true</code>
|
986
|
-
# in the RelatedResultSpec, return the list of notebooks to
|
987
|
-
# to which the returned related notes belong. The notebooks in this
|
988
|
-
# list will occur once per notebook GUID and are represented as
|
989
|
-
# NotebookDescriptor objects.</dd>
|
990
|
-
# </dl>
|
991
|
-
#
|
992
|
-
# <dt>debugInfo</dt>
|
993
|
-
# <dd>NOTE: This should be excluded from the public API.<br /><br />
|
994
|
-
# If <code>includeDebugInfo</code> in RelatedResultSpec is set to
|
995
|
-
# <code>true</code>, this field may contain debug information
|
996
|
-
# if the service decides to do so.</dd>
|
997
|
-
# </dl>
|
998
|
-
class RelatedResult
|
999
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
1000
|
-
NOTES = 1
|
1001
|
-
NOTEBOOKS = 2
|
1002
|
-
TAGS = 3
|
1003
|
-
CONTAININGNOTEBOOKS = 4
|
1004
|
-
DEBUGINFO = 5
|
1005
|
-
|
1006
|
-
FIELDS = {
|
1007
|
-
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Note}, :optional => true},
|
1008
|
-
NOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'notebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Notebook}, :optional => true},
|
1009
|
-
TAGS => {:type => ::Thrift::Types::LIST, :name => 'tags', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::Tag}, :optional => true},
|
1010
|
-
CONTAININGNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'containingNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => Evernote::EDAM::Type::NotebookDescriptor}, :optional => true},
|
1011
|
-
DEBUGINFO => {:type => ::Thrift::Types::STRING, :name => 'debugInfo', :optional => true}
|
1012
|
-
}
|
1013
|
-
|
1014
|
-
def struct_fields; FIELDS; end
|
1015
|
-
|
1016
|
-
def validate
|
1017
|
-
end
|
1018
|
-
|
1019
|
-
::Thrift::Struct.generate_accessors self
|
1020
|
-
end
|
1021
|
-
|
1022
|
-
# A description of the thing for which the service will find related
|
1023
|
-
# entities, via findRelated(), together with a description of what
|
1024
|
-
# type of entities and how many you are seeking in the
|
1025
|
-
# RelatedResult.
|
1026
|
-
#
|
1027
|
-
# <dl>
|
1028
|
-
# <dt>maxNotes</dt>
|
1029
|
-
# <dd>Return notes that are related to the query, but no more than
|
1030
|
-
# this many. Any value greater than EDAM_RELATED_MAX_NOTES
|
1031
|
-
# will be silently capped. If you do not set this field, then
|
1032
|
-
# no notes will be returned.</dd>
|
1033
|
-
#
|
1034
|
-
# <dt>maxNotebooks</dt>
|
1035
|
-
# <dd>Return notebooks that are related to the query, but no more than
|
1036
|
-
# this many. Any value greater than EDAM_RELATED_MAX_NOTEBOOKS
|
1037
|
-
# will be silently capped. If you do not set this field, then
|
1038
|
-
# no notebooks will be returned.</dd>
|
1039
|
-
#
|
1040
|
-
# <dt>maxTags</dt>
|
1041
|
-
# <dd>Return tags that are related to the query, but no more than
|
1042
|
-
# this many. Any value greater than EDAM_RELATED_MAX_TAGS
|
1043
|
-
# will be silently capped. If you do not set this field, then
|
1044
|
-
# no tags will be returned.</dd>
|
1045
|
-
# </dl>
|
1046
|
-
#
|
1047
|
-
# <dt>writableNotebooksOnly</dt>
|
1048
|
-
# <dd>Require that all returned related notebooks are writable.
|
1049
|
-
# The user will be able to create notes in all returned notebooks.
|
1050
|
-
# However, individual notes returned may still belong to notebooks
|
1051
|
-
# in which the user lacks the ability to create notes.</dd>
|
1052
|
-
# </dl>
|
1053
|
-
#
|
1054
|
-
# <dt>includeContainingNotebooks</dt>
|
1055
|
-
# <dd>If set to <code>true</code>, return the containingNotebooks field
|
1056
|
-
# in the RelatedResult, which will contain the list of notebooks to
|
1057
|
-
# to which the returned related notes belong.</dd>
|
1058
|
-
# </dl>
|
1059
|
-
#
|
1060
|
-
# <dt>includeDebugInfo</dt>
|
1061
|
-
# <dd>NOTE: This should be excluded from the public API.<br /><br />
|
1062
|
-
# If set to <code>true</code>, indicate that debug information should
|
1063
|
-
# be returned in the 'debugInfo' field of RelatedResult.</dd>
|
1064
|
-
# </dl>
|
1065
|
-
class RelatedResultSpec
|
1066
|
-
include ::Thrift::Struct, ::Thrift::Struct_Union
|
1067
|
-
MAXNOTES = 1
|
1068
|
-
MAXNOTEBOOKS = 2
|
1069
|
-
MAXTAGS = 3
|
1070
|
-
WRITABLENOTEBOOKSONLY = 4
|
1071
|
-
INCLUDECONTAININGNOTEBOOKS = 5
|
1072
|
-
INCLUDEDEBUGINFO = 6
|
1073
|
-
|
1074
|
-
FIELDS = {
|
1075
|
-
MAXNOTES => {:type => ::Thrift::Types::I32, :name => 'maxNotes', :optional => true},
|
1076
|
-
MAXNOTEBOOKS => {:type => ::Thrift::Types::I32, :name => 'maxNotebooks', :optional => true},
|
1077
|
-
MAXTAGS => {:type => ::Thrift::Types::I32, :name => 'maxTags', :optional => true},
|
1078
|
-
WRITABLENOTEBOOKSONLY => {:type => ::Thrift::Types::BOOL, :name => 'writableNotebooksOnly', :optional => true},
|
1079
|
-
INCLUDECONTAININGNOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeContainingNotebooks', :optional => true},
|
1080
|
-
INCLUDEDEBUGINFO => {:type => ::Thrift::Types::BOOL, :name => 'includeDebugInfo', :optional => true}
|
1081
|
-
}
|
1082
|
-
|
1083
|
-
def struct_fields; FIELDS; end
|
1084
|
-
|
1085
|
-
def validate
|
1086
|
-
end
|
1087
|
-
|
1088
|
-
::Thrift::Struct.generate_accessors self
|
1089
|
-
end
|
1090
|
-
|
1091
|
-
end
|
17
|
+
# This structure encapsulates the information about the state of the
|
18
|
+
# user's account for the purpose of "state based" synchronization.
|
19
|
+
# <dl>
|
20
|
+
# <dt>currentTime</dt>
|
21
|
+
# <dd>
|
22
|
+
# The server's current date and time.
|
23
|
+
# </dd>
|
24
|
+
#
|
25
|
+
# <dt>fullSyncBefore</dt>
|
26
|
+
# <dd>
|
27
|
+
# The cutoff date and time for client caches to be
|
28
|
+
# updated via incremental synchronization. Any clients that were last
|
29
|
+
# synched with the server before this date/time must do a full resync of all
|
30
|
+
# objects. This cutoff point will change over time as archival data is
|
31
|
+
# deleted or special circumstances on the service require resynchronization.
|
32
|
+
# </dd>
|
33
|
+
#
|
34
|
+
# <dt>updateCount</dt>
|
35
|
+
# <dd>
|
36
|
+
# Indicates the total number of transactions that have
|
37
|
+
# been committed within the account. This reflects (for example) the
|
38
|
+
# number of discrete additions or modifications that have been made to
|
39
|
+
# the data in this account (tags, notes, resources, etc.).
|
40
|
+
# This number is the "high water mark" for Update Sequence Numbers (USN)
|
41
|
+
# within the account.
|
42
|
+
# </dd>
|
43
|
+
#
|
44
|
+
# <dt>uploaded</dt>
|
45
|
+
# <dd>
|
46
|
+
# The total number of bytes that have been uploaded to
|
47
|
+
# this account in the current monthly period. This can be compared against
|
48
|
+
# Accounting.uploadLimit (from the UserStore) to determine how close the user
|
49
|
+
# is to their monthly upload limit.
|
50
|
+
# This value may not be present if the SyncState has been retrieved by
|
51
|
+
# a caller that only has read access to the account.
|
52
|
+
# </dd>
|
53
|
+
# </dl>
|
54
|
+
class SyncState
|
55
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
56
|
+
CURRENTTIME = 1
|
57
|
+
FULLSYNCBEFORE = 2
|
58
|
+
UPDATECOUNT = 3
|
59
|
+
UPLOADED = 4
|
60
|
+
|
61
|
+
FIELDS = {
|
62
|
+
CURRENTTIME => {:type => ::Thrift::Types::I64, :name => 'currentTime'},
|
63
|
+
FULLSYNCBEFORE => {:type => ::Thrift::Types::I64, :name => 'fullSyncBefore'},
|
64
|
+
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount'},
|
65
|
+
UPLOADED => {:type => ::Thrift::Types::I64, :name => 'uploaded', :optional => true}
|
66
|
+
}
|
67
|
+
|
68
|
+
def struct_fields; FIELDS; end
|
69
|
+
|
70
|
+
def validate
|
71
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field currentTime is unset!') unless @currentTime
|
72
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field fullSyncBefore is unset!') unless @fullSyncBefore
|
73
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updateCount is unset!') unless @updateCount
|
1092
74
|
end
|
75
|
+
|
76
|
+
::Thrift::Struct.generate_accessors self
|
77
|
+
end
|
78
|
+
|
79
|
+
# This structure is given out by the NoteStore when a client asks to
|
80
|
+
# receive the current state of an account. The client asks for the server's
|
81
|
+
# state one chunk at a time in order to allow clients to retrieve the state
|
82
|
+
# of a large account without needing to transfer the entire account in
|
83
|
+
# a single message.
|
84
|
+
#
|
85
|
+
# The server always gives SyncChunks using an ascending series of Update
|
86
|
+
# Sequence Numbers (USNs).
|
87
|
+
#
|
88
|
+
# <dl>
|
89
|
+
# <dt>currentTime</dt>
|
90
|
+
# <dd>
|
91
|
+
# The server's current date and time.
|
92
|
+
# </dd>
|
93
|
+
#
|
94
|
+
# <dt>chunkHighUSN</dt>
|
95
|
+
# <dd>
|
96
|
+
# The highest USN for any of the data objects represented
|
97
|
+
# in this sync chunk. If there are no objects in the chunk, this will not be
|
98
|
+
# set.
|
99
|
+
# </dd>
|
100
|
+
#
|
101
|
+
# <dt>updateCount</dt>
|
102
|
+
# <dd>
|
103
|
+
# The total number of updates that have been performed in
|
104
|
+
# the service for this account. This is equal to the highest USN within the
|
105
|
+
# account at the point that this SyncChunk was generated. If updateCount
|
106
|
+
# and chunkHighUSN are identical, that means that this is the last chunk
|
107
|
+
# in the account ... there is no more recent information.
|
108
|
+
# </dd>
|
109
|
+
#
|
110
|
+
# <dt>notes</dt>
|
111
|
+
# <dd>
|
112
|
+
# If present, this is a list of non-expunged notes that
|
113
|
+
# have a USN in this chunk. This will include notes that are "deleted"
|
114
|
+
# but not expunged (i.e. in the trash). The notes will include their list
|
115
|
+
# of tags and resources, but the resource content and recognition data
|
116
|
+
# will not be supplied.
|
117
|
+
# </dd>
|
118
|
+
#
|
119
|
+
# <dt>notebooks</dt>
|
120
|
+
# <dd>
|
121
|
+
# If present, this is a list of non-expunged notebooks that
|
122
|
+
# have a USN in this chunk. This will include notebooks that are "deleted"
|
123
|
+
# but not expunged (i.e. in the trash).
|
124
|
+
# </dd>
|
125
|
+
#
|
126
|
+
# <dt>tags</dt>
|
127
|
+
# <dd>
|
128
|
+
# If present, this is a list of the non-expunged tags that have a
|
129
|
+
# USN in this chunk.
|
130
|
+
# </dd>
|
131
|
+
#
|
132
|
+
# <dt>searches</dt>
|
133
|
+
# <dd>
|
134
|
+
# If present, this is a list of non-expunged searches that
|
135
|
+
# have a USN in this chunk.
|
136
|
+
# </dd>
|
137
|
+
#
|
138
|
+
# <dt>resources</dt>
|
139
|
+
# <dd>
|
140
|
+
# If present, this is a list of the non-expunged resources
|
141
|
+
# that have a USN in this chunk. This will include the metadata for each
|
142
|
+
# resource, but not its binary contents or recognition data, which must be
|
143
|
+
# retrieved separately.
|
144
|
+
# </dd>
|
145
|
+
#
|
146
|
+
# <dt>expungedNotes</dt>
|
147
|
+
# <dd>
|
148
|
+
# If present, the GUIDs of all of the notes that were
|
149
|
+
# permanently expunged in this chunk.
|
150
|
+
# </dd>
|
151
|
+
#
|
152
|
+
# <dt>expungedNotebooks</dt>
|
153
|
+
# <dd>
|
154
|
+
# If present, the GUIDs of all of the notebooks that
|
155
|
+
# were permanently expunged in this chunk. When a notebook is expunged,
|
156
|
+
# this implies that all of its child notes (and their resources) were
|
157
|
+
# also expunged.
|
158
|
+
# </dd>
|
159
|
+
#
|
160
|
+
# <dt>expungedTags</dt>
|
161
|
+
# <dd>
|
162
|
+
# If present, the GUIDs of all of the tags that were
|
163
|
+
# permanently expunged in this chunk.
|
164
|
+
# </dd>
|
165
|
+
#
|
166
|
+
# <dt>expungedSearches</dt>
|
167
|
+
# <dd>
|
168
|
+
# If present, the GUIDs of all of the saved searches
|
169
|
+
# that were permanently expunged in this chunk.
|
170
|
+
# </dd>
|
171
|
+
#
|
172
|
+
# <dt>linkedNotebooks</dt>
|
173
|
+
# <dd>
|
174
|
+
# If present, this is a list of non-expunged LinkedNotebooks that
|
175
|
+
# have a USN in this chunk.
|
176
|
+
# </dd>
|
177
|
+
#
|
178
|
+
# <dt>expungedLinkedNotebooks</dt>
|
179
|
+
# <dd>
|
180
|
+
# If present, the GUIDs of all of the LinkedNotebooks
|
181
|
+
# that were permanently expunged in this chunk.
|
182
|
+
# </dd>
|
183
|
+
# </dl>
|
184
|
+
class SyncChunk
|
185
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
186
|
+
CURRENTTIME = 1
|
187
|
+
CHUNKHIGHUSN = 2
|
188
|
+
UPDATECOUNT = 3
|
189
|
+
NOTES = 4
|
190
|
+
NOTEBOOKS = 5
|
191
|
+
TAGS = 6
|
192
|
+
SEARCHES = 7
|
193
|
+
RESOURCES = 8
|
194
|
+
EXPUNGEDNOTES = 9
|
195
|
+
EXPUNGEDNOTEBOOKS = 10
|
196
|
+
EXPUNGEDTAGS = 11
|
197
|
+
EXPUNGEDSEARCHES = 12
|
198
|
+
LINKEDNOTEBOOKS = 13
|
199
|
+
EXPUNGEDLINKEDNOTEBOOKS = 14
|
200
|
+
|
201
|
+
FIELDS = {
|
202
|
+
CURRENTTIME => {:type => ::Thrift::Types::I64, :name => 'currentTime'},
|
203
|
+
CHUNKHIGHUSN => {:type => ::Thrift::Types::I32, :name => 'chunkHighUSN', :optional => true},
|
204
|
+
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount'},
|
205
|
+
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Note}, :optional => true},
|
206
|
+
NOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'notebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Notebook}, :optional => true},
|
207
|
+
TAGS => {:type => ::Thrift::Types::LIST, :name => 'tags', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Tag}, :optional => true},
|
208
|
+
SEARCHES => {:type => ::Thrift::Types::LIST, :name => 'searches', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::SavedSearch}, :optional => true},
|
209
|
+
RESOURCES => {:type => ::Thrift::Types::LIST, :name => 'resources', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Resource}, :optional => true},
|
210
|
+
EXPUNGEDNOTES => {:type => ::Thrift::Types::LIST, :name => 'expungedNotes', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
211
|
+
EXPUNGEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'expungedNotebooks', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
212
|
+
EXPUNGEDTAGS => {:type => ::Thrift::Types::LIST, :name => 'expungedTags', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
213
|
+
EXPUNGEDSEARCHES => {:type => ::Thrift::Types::LIST, :name => 'expungedSearches', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
214
|
+
LINKEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'linkedNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::LinkedNotebook}, :optional => true},
|
215
|
+
EXPUNGEDLINKEDNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'expungedLinkedNotebooks', :element => {:type => ::Thrift::Types::STRING}, :optional => true}
|
216
|
+
}
|
217
|
+
|
218
|
+
def struct_fields; FIELDS; end
|
219
|
+
|
220
|
+
def validate
|
221
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field currentTime is unset!') unless @currentTime
|
222
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updateCount is unset!') unless @updateCount
|
223
|
+
end
|
224
|
+
|
225
|
+
::Thrift::Struct.generate_accessors self
|
226
|
+
end
|
227
|
+
|
228
|
+
# This structure is used with the 'getFilteredSyncChunk' call to provide
|
229
|
+
# fine-grained control over the data that's returned when a client needs
|
230
|
+
# to synchronize with the service. Each flag in this structure specifies
|
231
|
+
# whether to include one class of data in the results of that call.
|
232
|
+
#
|
233
|
+
# <dl>
|
234
|
+
# <dt>includeNotes</dt>
|
235
|
+
# <dd>
|
236
|
+
# If true, then the server will include the SyncChunks.notes field
|
237
|
+
# </dd>
|
238
|
+
#
|
239
|
+
# <dt>includeNoteResources</dt>
|
240
|
+
# <dd>
|
241
|
+
# If true, then the server will include the 'resources' field on all of
|
242
|
+
# the Notes that are in SyncChunk.notes.
|
243
|
+
# If 'includeNotes' is false, then this will have no effect.
|
244
|
+
# </dd>
|
245
|
+
#
|
246
|
+
# <dt>includeNoteAttributes</dt>
|
247
|
+
# <dd>
|
248
|
+
# If true, then the server will include the 'attributes' field on all of
|
249
|
+
# the Notes that are in SyncChunks.notes.
|
250
|
+
# If 'includeNotes' is false, then this will have no effect.
|
251
|
+
# </dd>
|
252
|
+
#
|
253
|
+
# <dt>includeNotebooks</dt>
|
254
|
+
# <dd>
|
255
|
+
# If true, then the server will include the SyncChunks.notebooks field
|
256
|
+
# </dd>
|
257
|
+
#
|
258
|
+
# <dt>includeTags</dt>
|
259
|
+
# <dd>
|
260
|
+
# If true, then the server will include the SyncChunks.tags field
|
261
|
+
# </dd>
|
262
|
+
#
|
263
|
+
# <dt>includeSearches</dt>
|
264
|
+
# <dd>
|
265
|
+
# If true, then the server will include the SyncChunks.searches field
|
266
|
+
# </dd>
|
267
|
+
#
|
268
|
+
# <dt>includeResources</dt>
|
269
|
+
# <dd>
|
270
|
+
# If true, then the server will include the SyncChunks.resources field.
|
271
|
+
# Since the Resources are also provided with their Note
|
272
|
+
# (in the Notes.resources list), this is primarily useful for clients that
|
273
|
+
# want to watch for changes to individual Resources due to recognition data
|
274
|
+
# being added.
|
275
|
+
# </dd>
|
276
|
+
#
|
277
|
+
# <dt>includeLinkedNotebooks</dt>
|
278
|
+
# <dd>
|
279
|
+
# If true, then the server will include the SyncChunks.linkedNotebooks field.
|
280
|
+
# </dd>
|
281
|
+
#
|
282
|
+
# <dt>includeExpunged</dt>
|
283
|
+
# <dd>
|
284
|
+
# If true, then the server will include the 'expunged' data for any type
|
285
|
+
# of included data. For example, if 'includeTags' and 'includeExpunged'
|
286
|
+
# are both true, then the SyncChunks.expungedTags field will be set with
|
287
|
+
# the GUIDs of tags that have been expunged from the server.
|
288
|
+
# </dd>
|
289
|
+
#
|
290
|
+
# <dt>includeNoteApplicationDataFullMap</dt>
|
291
|
+
# <dd>
|
292
|
+
# If true, then the values for the applicationData map will be filled
|
293
|
+
# in, assuming notes and note attributes are being returned. Otherwise,
|
294
|
+
# only the keysOnly field will be filled in.
|
295
|
+
# </dd>
|
296
|
+
#
|
297
|
+
# <dt>includeResourceApplicationDataFullMap</dt>
|
298
|
+
# <dd>
|
299
|
+
# If true, then the fullMap values for the applicationData map will be
|
300
|
+
# filled in, assuming resources and resource attributes are being returned
|
301
|
+
# (includeResources is true). Otherwise, only the keysOnly field will be
|
302
|
+
# filled in.
|
303
|
+
# </dd>
|
304
|
+
#
|
305
|
+
# <dt>includeNoteResourceApplicationDataFullMap</dt>
|
306
|
+
# <dd>
|
307
|
+
# If true, then the fullMap values for the applicationData map will be
|
308
|
+
# filled in for resources found inside of notes, assuming resources are
|
309
|
+
# being returned in notes (includeNoteResources is true). Otherwise,
|
310
|
+
# only the keysOnly field will be filled in.
|
311
|
+
# </dd>
|
312
|
+
#
|
313
|
+
# <dt>requireNoteContentClass</dt>
|
314
|
+
# <dd>
|
315
|
+
# If set, then only send notes whose content class matches this value.
|
316
|
+
# The value can be a literal match or, if the last character is an
|
317
|
+
# asterisk, a prefix match.
|
318
|
+
# </dd>
|
319
|
+
# </dl>
|
320
|
+
class SyncChunkFilter
|
321
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
322
|
+
INCLUDENOTES = 1
|
323
|
+
INCLUDENOTERESOURCES = 2
|
324
|
+
INCLUDENOTEATTRIBUTES = 3
|
325
|
+
INCLUDENOTEBOOKS = 4
|
326
|
+
INCLUDETAGS = 5
|
327
|
+
INCLUDESEARCHES = 6
|
328
|
+
INCLUDERESOURCES = 7
|
329
|
+
INCLUDELINKEDNOTEBOOKS = 8
|
330
|
+
INCLUDEEXPUNGED = 9
|
331
|
+
INCLUDENOTEAPPLICATIONDATAFULLMAP = 10
|
332
|
+
INCLUDERESOURCEAPPLICATIONDATAFULLMAP = 12
|
333
|
+
INCLUDENOTERESOURCEAPPLICATIONDATAFULLMAP = 13
|
334
|
+
REQUIRENOTECONTENTCLASS = 11
|
335
|
+
|
336
|
+
FIELDS = {
|
337
|
+
INCLUDENOTES => {:type => ::Thrift::Types::BOOL, :name => 'includeNotes', :optional => true},
|
338
|
+
INCLUDENOTERESOURCES => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteResources', :optional => true},
|
339
|
+
INCLUDENOTEATTRIBUTES => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteAttributes', :optional => true},
|
340
|
+
INCLUDENOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeNotebooks', :optional => true},
|
341
|
+
INCLUDETAGS => {:type => ::Thrift::Types::BOOL, :name => 'includeTags', :optional => true},
|
342
|
+
INCLUDESEARCHES => {:type => ::Thrift::Types::BOOL, :name => 'includeSearches', :optional => true},
|
343
|
+
INCLUDERESOURCES => {:type => ::Thrift::Types::BOOL, :name => 'includeResources', :optional => true},
|
344
|
+
INCLUDELINKEDNOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeLinkedNotebooks', :optional => true},
|
345
|
+
INCLUDEEXPUNGED => {:type => ::Thrift::Types::BOOL, :name => 'includeExpunged', :optional => true},
|
346
|
+
INCLUDENOTEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteApplicationDataFullMap', :optional => true},
|
347
|
+
INCLUDERESOURCEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeResourceApplicationDataFullMap', :optional => true},
|
348
|
+
INCLUDENOTERESOURCEAPPLICATIONDATAFULLMAP => {:type => ::Thrift::Types::BOOL, :name => 'includeNoteResourceApplicationDataFullMap', :optional => true},
|
349
|
+
REQUIRENOTECONTENTCLASS => {:type => ::Thrift::Types::STRING, :name => 'requireNoteContentClass', :optional => true}
|
350
|
+
}
|
351
|
+
|
352
|
+
def struct_fields; FIELDS; end
|
353
|
+
|
354
|
+
def validate
|
355
|
+
end
|
356
|
+
|
357
|
+
::Thrift::Struct.generate_accessors self
|
358
|
+
end
|
359
|
+
|
360
|
+
# A list of criteria that are used to indicate which notes are desired from
|
361
|
+
# the account. This is used in queries to the NoteStore to determine
|
362
|
+
# which notes should be retrieved.
|
363
|
+
#
|
364
|
+
# <dl>
|
365
|
+
# <dt>order</dt>
|
366
|
+
# <dd>
|
367
|
+
# The NoteSortOrder value indicating what criterion should be
|
368
|
+
# used to sort the results of the filter.
|
369
|
+
# </dd>
|
370
|
+
#
|
371
|
+
# <dt>ascending</dt>
|
372
|
+
# <dd>
|
373
|
+
# If true, the results will be ascending in the requested
|
374
|
+
# sort order. If false, the results will be descending.
|
375
|
+
# </dd>
|
376
|
+
#
|
377
|
+
# <dt>words</dt>
|
378
|
+
# <dd>
|
379
|
+
# If present, a search query string that will filter the set of notes to be returned.
|
380
|
+
# Accepts the full search grammar documented in the Evernote API Overview.
|
381
|
+
# </dd>
|
382
|
+
#
|
383
|
+
# <dt>notebookGuid</dt>
|
384
|
+
# <dd>
|
385
|
+
# If present, the Guid of the notebook that must contain
|
386
|
+
# the notes.
|
387
|
+
# </dd>
|
388
|
+
#
|
389
|
+
# <dt>tagGuids</dt>
|
390
|
+
# <dd>
|
391
|
+
# If present, the list of tags (by GUID) that must be present
|
392
|
+
# on the notes.
|
393
|
+
# </dd>
|
394
|
+
#
|
395
|
+
# <dt>timeZone</dt>
|
396
|
+
# <dd>
|
397
|
+
# The zone ID for the user, which will be used to interpret
|
398
|
+
# any dates or times in the queries that do not include their desired zone
|
399
|
+
# information.
|
400
|
+
# For example, if a query requests notes created "yesterday", this
|
401
|
+
# will be evaluated from the provided time zone, if provided.
|
402
|
+
# The format must be encoded as a standard zone ID such as
|
403
|
+
# "America/Los_Angeles".
|
404
|
+
# </dd>
|
405
|
+
#
|
406
|
+
# <dt>inactive</dt>
|
407
|
+
# <dd>
|
408
|
+
# If true, then only notes that are not active (i.e. notes in
|
409
|
+
# the Trash) will be returned. Otherwise, only active notes will be returned.
|
410
|
+
# There is no way to find both active and inactive notes in a single query.
|
411
|
+
# </dd>
|
412
|
+
#
|
413
|
+
# <dt>emphasized</dt>
|
414
|
+
# <dd>
|
415
|
+
# If present, a search query string that may or may not influence the notes
|
416
|
+
# to be returned, both in terms of coverage as well as of order. Think of it
|
417
|
+
# as a wish list, not a requirement.
|
418
|
+
# Accepts the full search grammar documented in the Evernote API Overview.
|
419
|
+
# </dd>
|
420
|
+
# </dl>
|
421
|
+
class NoteFilter
|
422
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
423
|
+
ORDER = 1
|
424
|
+
ASCENDING = 2
|
425
|
+
WORDS = 3
|
426
|
+
NOTEBOOKGUID = 4
|
427
|
+
TAGGUIDS = 5
|
428
|
+
TIMEZONE = 6
|
429
|
+
INACTIVE = 7
|
430
|
+
EMPHASIZED = 8
|
431
|
+
|
432
|
+
FIELDS = {
|
433
|
+
ORDER => {:type => ::Thrift::Types::I32, :name => 'order', :optional => true},
|
434
|
+
ASCENDING => {:type => ::Thrift::Types::BOOL, :name => 'ascending', :optional => true},
|
435
|
+
WORDS => {:type => ::Thrift::Types::STRING, :name => 'words', :optional => true},
|
436
|
+
NOTEBOOKGUID => {:type => ::Thrift::Types::STRING, :name => 'notebookGuid', :optional => true},
|
437
|
+
TAGGUIDS => {:type => ::Thrift::Types::LIST, :name => 'tagGuids', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
438
|
+
TIMEZONE => {:type => ::Thrift::Types::STRING, :name => 'timeZone', :optional => true},
|
439
|
+
INACTIVE => {:type => ::Thrift::Types::BOOL, :name => 'inactive', :optional => true},
|
440
|
+
EMPHASIZED => {:type => ::Thrift::Types::STRING, :name => 'emphasized', :optional => true}
|
441
|
+
}
|
442
|
+
|
443
|
+
def struct_fields; FIELDS; end
|
444
|
+
|
445
|
+
def validate
|
446
|
+
end
|
447
|
+
|
448
|
+
::Thrift::Struct.generate_accessors self
|
449
|
+
end
|
450
|
+
|
451
|
+
# A small structure for returning a list of notes out of a larger set.
|
452
|
+
#
|
453
|
+
# <dl>
|
454
|
+
# <dt>startIndex</dt>
|
455
|
+
# <dd>
|
456
|
+
# The starting index within the overall set of notes. This
|
457
|
+
# is also the number of notes that are "before" this list in the set.
|
458
|
+
# </dd>
|
459
|
+
#
|
460
|
+
# <dt>totalNotes</dt>
|
461
|
+
# <dd>
|
462
|
+
# The number of notes in the larger set. This can be used
|
463
|
+
# to calculate how many notes are "after" this note in the set.
|
464
|
+
# (I.e. remaining = totalNotes - (startIndex + notes.length) )
|
465
|
+
# </dd>
|
466
|
+
#
|
467
|
+
# <dt>notes</dt>
|
468
|
+
# <dd>
|
469
|
+
# The list of notes from this range. The Notes will include all
|
470
|
+
# metadata (attributes, resources, etc.), but will not include the ENML
|
471
|
+
# content of the note or the binary contents of any resources.
|
472
|
+
# </dd>
|
473
|
+
#
|
474
|
+
# <dt>stoppedWords</dt>
|
475
|
+
# <dd>
|
476
|
+
# If the NoteList was produced using a text based search
|
477
|
+
# query that included words that are not indexed or searched by the service,
|
478
|
+
# this will include a list of those ignored words.
|
479
|
+
# </dd>
|
480
|
+
#
|
481
|
+
# <dt>searchedWords</dt>
|
482
|
+
# <dd>
|
483
|
+
# If the NoteList was produced using a text based search
|
484
|
+
# query that included viable search words or quoted expressions, this will
|
485
|
+
# include a list of those words. Any stopped words will not be included
|
486
|
+
# in this list.
|
487
|
+
# </dd>
|
488
|
+
#
|
489
|
+
# <dt>updateCount</dt>
|
490
|
+
# <dd>
|
491
|
+
# Indicates the total number of transactions that have
|
492
|
+
# been committed within the account. This reflects (for example) the
|
493
|
+
# number of discrete additions or modifications that have been made to
|
494
|
+
# the data in this account (tags, notes, resources, etc.).
|
495
|
+
# This number is the "high water mark" for Update Sequence Numbers (USN)
|
496
|
+
# within the account.
|
497
|
+
# </dd>
|
498
|
+
# </dl>
|
499
|
+
class NoteList
|
500
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
501
|
+
STARTINDEX = 1
|
502
|
+
TOTALNOTES = 2
|
503
|
+
NOTES = 3
|
504
|
+
STOPPEDWORDS = 4
|
505
|
+
SEARCHEDWORDS = 5
|
506
|
+
UPDATECOUNT = 6
|
507
|
+
|
508
|
+
FIELDS = {
|
509
|
+
STARTINDEX => {:type => ::Thrift::Types::I32, :name => 'startIndex'},
|
510
|
+
TOTALNOTES => {:type => ::Thrift::Types::I32, :name => 'totalNotes'},
|
511
|
+
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Note}},
|
512
|
+
STOPPEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'stoppedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
513
|
+
SEARCHEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'searchedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
514
|
+
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount', :optional => true}
|
515
|
+
}
|
516
|
+
|
517
|
+
def struct_fields; FIELDS; end
|
518
|
+
|
519
|
+
def validate
|
520
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field startIndex is unset!') unless @startIndex
|
521
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field totalNotes is unset!') unless @totalNotes
|
522
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field notes is unset!') unless @notes
|
523
|
+
end
|
524
|
+
|
525
|
+
::Thrift::Struct.generate_accessors self
|
526
|
+
end
|
527
|
+
|
528
|
+
# This structure is used in the set of results returned by the
|
529
|
+
# findNotesMetadata function. It represents the high-level information about
|
530
|
+
# a single Note, without some of the larger deep structure. This allows
|
531
|
+
# for the information about a list of Notes to be returned relatively quickly
|
532
|
+
# with less marshalling and data transfer to remote clients.
|
533
|
+
# Most fields in this structure are identical to the corresponding field in
|
534
|
+
# the Note structure, with the exception of:
|
535
|
+
#
|
536
|
+
# <dl>
|
537
|
+
# <dt>largestResourceMime</dt>
|
538
|
+
# <dd>If set, then this will contain the MIME type of the largest Resource
|
539
|
+
# (in bytes) within the Note. This may be useful, for example, to choose
|
540
|
+
# an appropriate icon or thumbnail to represent the Note.
|
541
|
+
# </dd>
|
542
|
+
#
|
543
|
+
# <dt>largestResourceSize</dt>
|
544
|
+
# <dd>If set, this will contain the size of the largest Resource file, in
|
545
|
+
# bytes, within the Note. This may be useful, for example, to decide whether
|
546
|
+
# to ask the server for a thumbnail to represent the Note.
|
547
|
+
# </dd>
|
548
|
+
# </dl>
|
549
|
+
class NoteMetadata
|
550
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
551
|
+
GUID = 1
|
552
|
+
TITLE = 2
|
553
|
+
CONTENTLENGTH = 5
|
554
|
+
CREATED = 6
|
555
|
+
UPDATED = 7
|
556
|
+
UPDATESEQUENCENUM = 10
|
557
|
+
NOTEBOOKGUID = 11
|
558
|
+
TAGGUIDS = 12
|
559
|
+
ATTRIBUTES = 14
|
560
|
+
LARGESTRESOURCEMIME = 20
|
561
|
+
LARGESTRESOURCESIZE = 21
|
562
|
+
|
563
|
+
FIELDS = {
|
564
|
+
GUID => {:type => ::Thrift::Types::STRING, :name => 'guid'},
|
565
|
+
TITLE => {:type => ::Thrift::Types::STRING, :name => 'title', :optional => true},
|
566
|
+
CONTENTLENGTH => {:type => ::Thrift::Types::I32, :name => 'contentLength', :optional => true},
|
567
|
+
CREATED => {:type => ::Thrift::Types::I64, :name => 'created', :optional => true},
|
568
|
+
UPDATED => {:type => ::Thrift::Types::I64, :name => 'updated', :optional => true},
|
569
|
+
UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum', :optional => true},
|
570
|
+
NOTEBOOKGUID => {:type => ::Thrift::Types::STRING, :name => 'notebookGuid', :optional => true},
|
571
|
+
TAGGUIDS => {:type => ::Thrift::Types::LIST, :name => 'tagGuids', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
572
|
+
ATTRIBUTES => {:type => ::Thrift::Types::STRUCT, :name => 'attributes', :class => ::Evernote::EDAM::Type::NoteAttributes, :optional => true},
|
573
|
+
LARGESTRESOURCEMIME => {:type => ::Thrift::Types::STRING, :name => 'largestResourceMime', :optional => true},
|
574
|
+
LARGESTRESOURCESIZE => {:type => ::Thrift::Types::I32, :name => 'largestResourceSize', :optional => true}
|
575
|
+
}
|
576
|
+
|
577
|
+
def struct_fields; FIELDS; end
|
578
|
+
|
579
|
+
def validate
|
580
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field guid is unset!') unless @guid
|
581
|
+
end
|
582
|
+
|
583
|
+
::Thrift::Struct.generate_accessors self
|
584
|
+
end
|
585
|
+
|
586
|
+
# This structure is returned from calls to the findNotesMetadata function to
|
587
|
+
# give the high-level metadata about a subset of Notes that are found to
|
588
|
+
# match a specified NoteFilter in a search.
|
589
|
+
#
|
590
|
+
# <dl>
|
591
|
+
# <dt>startIndex</dt>
|
592
|
+
# <dd>
|
593
|
+
# The starting index within the overall set of notes. This
|
594
|
+
# is also the number of notes that are "before" this list in the set.
|
595
|
+
# </dd>
|
596
|
+
#
|
597
|
+
# <dt>totalNotes</dt>
|
598
|
+
# <dd>
|
599
|
+
# The number of notes in the larger set. This can be used
|
600
|
+
# to calculate how many notes are "after" this note in the set.
|
601
|
+
# (I.e. remaining = totalNotes - (startIndex + notes.length) )
|
602
|
+
# </dd>
|
603
|
+
#
|
604
|
+
# <dt>notes</dt>
|
605
|
+
# <dd>
|
606
|
+
# The list of metadata for Notes in this range. The set of optional fields
|
607
|
+
# that are set in each metadata structure will depend on the
|
608
|
+
# NotesMetadataResultSpec provided by the caller when the search was
|
609
|
+
# performed. Only the 'guid' field will be guaranteed to be set in each
|
610
|
+
# Note.
|
611
|
+
# </dd>
|
612
|
+
#
|
613
|
+
# <dt>stoppedWords</dt>
|
614
|
+
# <dd>
|
615
|
+
# If the NoteList was produced using a text based search
|
616
|
+
# query that included words that are not indexed or searched by the service,
|
617
|
+
# this will include a list of those ignored words.
|
618
|
+
# </dd>
|
619
|
+
#
|
620
|
+
# <dt>searchedWords</dt>
|
621
|
+
# <dd>
|
622
|
+
# If the NoteList was produced using a text based search
|
623
|
+
# query that included viable search words or quoted expressions, this will
|
624
|
+
# include a list of those words. Any stopped words will not be included
|
625
|
+
# in this list.
|
626
|
+
# </dd>
|
627
|
+
#
|
628
|
+
# <dt>updateCount</dt>
|
629
|
+
# <dd>
|
630
|
+
# Indicates the total number of transactions that have
|
631
|
+
# been committed within the account. This reflects (for example) the
|
632
|
+
# number of discrete additions or modifications that have been made to
|
633
|
+
# the data in this account (tags, notes, resources, etc.).
|
634
|
+
# This number is the "high water mark" for Update Sequence Numbers (USN)
|
635
|
+
# within the account.
|
636
|
+
# </dd>
|
637
|
+
# </dl>
|
638
|
+
class NotesMetadataList
|
639
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
640
|
+
STARTINDEX = 1
|
641
|
+
TOTALNOTES = 2
|
642
|
+
NOTES = 3
|
643
|
+
STOPPEDWORDS = 4
|
644
|
+
SEARCHEDWORDS = 5
|
645
|
+
UPDATECOUNT = 6
|
646
|
+
|
647
|
+
FIELDS = {
|
648
|
+
STARTINDEX => {:type => ::Thrift::Types::I32, :name => 'startIndex'},
|
649
|
+
TOTALNOTES => {:type => ::Thrift::Types::I32, :name => 'totalNotes'},
|
650
|
+
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::NoteStore::NoteMetadata}},
|
651
|
+
STOPPEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'stoppedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
652
|
+
SEARCHEDWORDS => {:type => ::Thrift::Types::LIST, :name => 'searchedWords', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
653
|
+
UPDATECOUNT => {:type => ::Thrift::Types::I32, :name => 'updateCount', :optional => true}
|
654
|
+
}
|
655
|
+
|
656
|
+
def struct_fields; FIELDS; end
|
657
|
+
|
658
|
+
def validate
|
659
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field startIndex is unset!') unless @startIndex
|
660
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field totalNotes is unset!') unless @totalNotes
|
661
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field notes is unset!') unless @notes
|
662
|
+
end
|
663
|
+
|
664
|
+
::Thrift::Struct.generate_accessors self
|
665
|
+
end
|
666
|
+
|
667
|
+
# This structure is provided to the findNotesMetadata function to specify
|
668
|
+
# the subset of fields that should be included in each NoteMetadata element
|
669
|
+
# that is returned in the NotesMetadataList.
|
670
|
+
# Each field on this structure is a boolean flag that indicates whether the
|
671
|
+
# corresponding field should be included in the NoteMetadata structure when
|
672
|
+
# it is returned. For example, if the 'includeTitle' field is set on this
|
673
|
+
# structure when calling findNotesMetadata, then each NoteMetadata in the
|
674
|
+
# list should have its 'title' field set.
|
675
|
+
# If one of the fields in this spec is not set, then it will be treated as
|
676
|
+
# 'false' by the server, so the default behavior is to include nothing in
|
677
|
+
# replies (but the mandatory GUID)
|
678
|
+
class NotesMetadataResultSpec
|
679
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
680
|
+
INCLUDETITLE = 2
|
681
|
+
INCLUDECONTENTLENGTH = 5
|
682
|
+
INCLUDECREATED = 6
|
683
|
+
INCLUDEUPDATED = 7
|
684
|
+
INCLUDEUPDATESEQUENCENUM = 10
|
685
|
+
INCLUDENOTEBOOKGUID = 11
|
686
|
+
INCLUDETAGGUIDS = 12
|
687
|
+
INCLUDEATTRIBUTES = 14
|
688
|
+
INCLUDELARGESTRESOURCEMIME = 20
|
689
|
+
INCLUDELARGESTRESOURCESIZE = 21
|
690
|
+
|
691
|
+
FIELDS = {
|
692
|
+
INCLUDETITLE => {:type => ::Thrift::Types::BOOL, :name => 'includeTitle', :optional => true},
|
693
|
+
INCLUDECONTENTLENGTH => {:type => ::Thrift::Types::BOOL, :name => 'includeContentLength', :optional => true},
|
694
|
+
INCLUDECREATED => {:type => ::Thrift::Types::BOOL, :name => 'includeCreated', :optional => true},
|
695
|
+
INCLUDEUPDATED => {:type => ::Thrift::Types::BOOL, :name => 'includeUpdated', :optional => true},
|
696
|
+
INCLUDEUPDATESEQUENCENUM => {:type => ::Thrift::Types::BOOL, :name => 'includeUpdateSequenceNum', :optional => true},
|
697
|
+
INCLUDENOTEBOOKGUID => {:type => ::Thrift::Types::BOOL, :name => 'includeNotebookGuid', :optional => true},
|
698
|
+
INCLUDETAGGUIDS => {:type => ::Thrift::Types::BOOL, :name => 'includeTagGuids', :optional => true},
|
699
|
+
INCLUDEATTRIBUTES => {:type => ::Thrift::Types::BOOL, :name => 'includeAttributes', :optional => true},
|
700
|
+
INCLUDELARGESTRESOURCEMIME => {:type => ::Thrift::Types::BOOL, :name => 'includeLargestResourceMime', :optional => true},
|
701
|
+
INCLUDELARGESTRESOURCESIZE => {:type => ::Thrift::Types::BOOL, :name => 'includeLargestResourceSize', :optional => true}
|
702
|
+
}
|
703
|
+
|
704
|
+
def struct_fields; FIELDS; end
|
705
|
+
|
706
|
+
def validate
|
707
|
+
end
|
708
|
+
|
709
|
+
::Thrift::Struct.generate_accessors self
|
1093
710
|
end
|
711
|
+
|
712
|
+
# A data structure representing the number of notes for each notebook
|
713
|
+
# and tag with a non-zero set of applicable notes.
|
714
|
+
#
|
715
|
+
# <dl>
|
716
|
+
# <dt>notebookCounts</dt>
|
717
|
+
# <dd>
|
718
|
+
# A mapping from the Notebook GUID to the number of
|
719
|
+
# notes (from some selection) that are in the corresponding notebook.
|
720
|
+
# </dd>
|
721
|
+
#
|
722
|
+
# <dt>tagCounts</dt>
|
723
|
+
# <dd>
|
724
|
+
# A mapping from the Tag GUID to the number of notes (from some
|
725
|
+
# selection) that have the corresponding tag.
|
726
|
+
# </dd>
|
727
|
+
#
|
728
|
+
# <dt>trashCount</dt>
|
729
|
+
# <dd>
|
730
|
+
# If this is set, then this is the number of notes that are in the trash.
|
731
|
+
# If this is not set, then the number of notes in the trash hasn't been
|
732
|
+
# reported. (I.e. if there are no notes in the trash, this will be set
|
733
|
+
# to 0.)
|
734
|
+
# </dd>
|
735
|
+
# </dl>
|
736
|
+
class NoteCollectionCounts
|
737
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
738
|
+
NOTEBOOKCOUNTS = 1
|
739
|
+
TAGCOUNTS = 2
|
740
|
+
TRASHCOUNT = 3
|
741
|
+
|
742
|
+
FIELDS = {
|
743
|
+
NOTEBOOKCOUNTS => {:type => ::Thrift::Types::MAP, :name => 'notebookCounts', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::I32}, :optional => true},
|
744
|
+
TAGCOUNTS => {:type => ::Thrift::Types::MAP, :name => 'tagCounts', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::I32}, :optional => true},
|
745
|
+
TRASHCOUNT => {:type => ::Thrift::Types::I32, :name => 'trashCount', :optional => true}
|
746
|
+
}
|
747
|
+
|
748
|
+
def struct_fields; FIELDS; end
|
749
|
+
|
750
|
+
def validate
|
751
|
+
end
|
752
|
+
|
753
|
+
::Thrift::Struct.generate_accessors self
|
754
|
+
end
|
755
|
+
|
756
|
+
# Parameters that must be given to the NoteStore emailNote call. These allow
|
757
|
+
# the caller to specify the note to send, the recipient addresses, etc.
|
758
|
+
#
|
759
|
+
# <dl>
|
760
|
+
# <dt>guid</dt>
|
761
|
+
# <dd>
|
762
|
+
# If set, this must be the GUID of a note within the user's account that
|
763
|
+
# should be retrieved from the service and sent as email. If not set,
|
764
|
+
# the 'note' field must be provided instead.
|
765
|
+
# </dd>
|
766
|
+
#
|
767
|
+
# <dt>note</dt>
|
768
|
+
# <dd>
|
769
|
+
# If the 'guid' field is not set, this field must be provided, including
|
770
|
+
# the full contents of the note note (and all of its Resources) to send.
|
771
|
+
# This can be used for a Note that as not been created in the service,
|
772
|
+
# for example by a local client with local notes.
|
773
|
+
# </dd>
|
774
|
+
#
|
775
|
+
# <dt>toAddresses</dt>
|
776
|
+
# <dd>
|
777
|
+
# If provided, this should contain a list of the SMTP email addresses
|
778
|
+
# that should be included in the "To:" line of the email.
|
779
|
+
# Callers must specify at least one "to" or "cc" email address.
|
780
|
+
# </dd>
|
781
|
+
#
|
782
|
+
# <dt>ccAddresses</dt>
|
783
|
+
# <dd>
|
784
|
+
# If provided, this should contain a list of the SMTP email addresses
|
785
|
+
# that should be included in the "Cc:" line of the email.
|
786
|
+
# Callers must specify at least one "to" or "cc" email address.
|
787
|
+
# </dd>
|
788
|
+
#
|
789
|
+
# <dt>subject</dt>
|
790
|
+
# <dd>
|
791
|
+
# If provided, this should contain the subject line of the email that
|
792
|
+
# will be sent. If not provided, the title of the note will be used
|
793
|
+
# as the subject of the email.
|
794
|
+
# </dd>
|
795
|
+
#
|
796
|
+
# <dt>message</dt>
|
797
|
+
# <dd>
|
798
|
+
# If provided, this is additional personal text that should be included
|
799
|
+
# into the email as a message from the owner to the recipient(s).
|
800
|
+
# </dd>
|
801
|
+
# </dl>
|
802
|
+
class NoteEmailParameters
|
803
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
804
|
+
GUID = 1
|
805
|
+
NOTE = 2
|
806
|
+
TOADDRESSES = 3
|
807
|
+
CCADDRESSES = 4
|
808
|
+
SUBJECT = 5
|
809
|
+
MESSAGE = 6
|
810
|
+
|
811
|
+
FIELDS = {
|
812
|
+
GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true},
|
813
|
+
NOTE => {:type => ::Thrift::Types::STRUCT, :name => 'note', :class => ::Evernote::EDAM::Type::Note, :optional => true},
|
814
|
+
TOADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'toAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
815
|
+
CCADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'ccAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true},
|
816
|
+
SUBJECT => {:type => ::Thrift::Types::STRING, :name => 'subject', :optional => true},
|
817
|
+
MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message', :optional => true}
|
818
|
+
}
|
819
|
+
|
820
|
+
def struct_fields; FIELDS; end
|
821
|
+
|
822
|
+
def validate
|
823
|
+
end
|
824
|
+
|
825
|
+
::Thrift::Struct.generate_accessors self
|
826
|
+
end
|
827
|
+
|
828
|
+
# Identifying information about previous versions of a note that are backed up
|
829
|
+
# within Evernote's servers. Used in the return value of the listNoteVersions
|
830
|
+
# call.
|
831
|
+
#
|
832
|
+
# <dl>
|
833
|
+
# <dt>updateSequenceNum</dt>
|
834
|
+
# <dd>
|
835
|
+
# The update sequence number for the Note when it last had this content.
|
836
|
+
# This serves to uniquely identify each version of the note, since USN
|
837
|
+
# values are unique within an account for each update.
|
838
|
+
# </dd>
|
839
|
+
# <dt>updated</dt>
|
840
|
+
# <dd>
|
841
|
+
# The 'updated' time that was set on the Note when it had this version
|
842
|
+
# of the content. This is the user-modifiable modification time on the
|
843
|
+
# note, so it's not reliable for guaranteeing the order of various
|
844
|
+
# versions. (E.g. if someone modifies the note, then changes this time
|
845
|
+
# manually into the past and then updates the note again.)
|
846
|
+
# </dd>
|
847
|
+
# <dt>saved</dt>
|
848
|
+
# <dd>
|
849
|
+
# A timestamp that holds the date and time when this version of the note
|
850
|
+
# was backed up by Evernote's servers. This
|
851
|
+
# </dd>
|
852
|
+
# <dt>title</dt>
|
853
|
+
# <dd>
|
854
|
+
# The title of the note when this particular version was saved. (The
|
855
|
+
# current title of the note may differ from this value.)
|
856
|
+
# </dd>
|
857
|
+
# </dl>
|
858
|
+
class NoteVersionId
|
859
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
860
|
+
UPDATESEQUENCENUM = 1
|
861
|
+
UPDATED = 2
|
862
|
+
SAVED = 3
|
863
|
+
TITLE = 4
|
864
|
+
|
865
|
+
FIELDS = {
|
866
|
+
UPDATESEQUENCENUM => {:type => ::Thrift::Types::I32, :name => 'updateSequenceNum'},
|
867
|
+
UPDATED => {:type => ::Thrift::Types::I64, :name => 'updated'},
|
868
|
+
SAVED => {:type => ::Thrift::Types::I64, :name => 'saved'},
|
869
|
+
TITLE => {:type => ::Thrift::Types::STRING, :name => 'title'}
|
870
|
+
}
|
871
|
+
|
872
|
+
def struct_fields; FIELDS; end
|
873
|
+
|
874
|
+
def validate
|
875
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updateSequenceNum is unset!') unless @updateSequenceNum
|
876
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field updated is unset!') unless @updated
|
877
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field saved is unset!') unless @saved
|
878
|
+
raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field title is unset!') unless @title
|
879
|
+
end
|
880
|
+
|
881
|
+
::Thrift::Struct.generate_accessors self
|
882
|
+
end
|
883
|
+
|
884
|
+
# This structure is passed from clients to the Evernote service when they wish
|
885
|
+
# to relay coarse-grained usage metrics to the service to help improve
|
886
|
+
# products.
|
887
|
+
#
|
888
|
+
# <dl>
|
889
|
+
# <dt>sessions</dt>
|
890
|
+
# <dd>
|
891
|
+
# This field contains a count of the number of usage "sessions" that have
|
892
|
+
# occurred with this client which have not previously been reported to
|
893
|
+
# the service.
|
894
|
+
# A "session" is defined as one of the 96 fifteen-minute intervals of the
|
895
|
+
# day when someone used Evernote's interface at least once.
|
896
|
+
# So if a user interacts with an Evernote client at 12:18, 12:24, and 12:36,
|
897
|
+
# and then the client synchronizes at 12:39, it would report that there were
|
898
|
+
# two previously-unreported sessions (one session for the 12:15-12:30 time
|
899
|
+
# period, and one for the 12:30-12:45 period).
|
900
|
+
# If the user used Evernote again at 12:41 and synchronized at 12:43, it
|
901
|
+
# would not report any new sessions, because the 12:30-12:45 session had
|
902
|
+
# already been reported.
|
903
|
+
# </dd>
|
904
|
+
# </dl>
|
905
|
+
class ClientUsageMetrics
|
906
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
907
|
+
SESSIONS = 1
|
908
|
+
|
909
|
+
FIELDS = {
|
910
|
+
SESSIONS => {:type => ::Thrift::Types::I32, :name => 'sessions', :optional => true}
|
911
|
+
}
|
912
|
+
|
913
|
+
def struct_fields; FIELDS; end
|
914
|
+
|
915
|
+
def validate
|
916
|
+
end
|
917
|
+
|
918
|
+
::Thrift::Struct.generate_accessors self
|
919
|
+
end
|
920
|
+
|
921
|
+
# A description of the thing for which we are searching for related
|
922
|
+
# entities.
|
923
|
+
#
|
924
|
+
# You must specify either <em>noteGuid</em> or <em>plainText</em>, but
|
925
|
+
# not both. <em>filter</em> is optional.
|
926
|
+
#
|
927
|
+
# <dl>
|
928
|
+
# <dt>noteGuid</dt>
|
929
|
+
# <dd>The GUID of an existing note in your account for which related
|
930
|
+
# entities will be found.</dd>
|
931
|
+
#
|
932
|
+
# <dt>plainText</dt>
|
933
|
+
# <dd>A string of plain text for which to find related entities.
|
934
|
+
# You should provide a text block with a number of characters between
|
935
|
+
# EDAM_RELATED_PLAINTEXT_LEN_MIN and EDAM_RELATED_PLAINTEXT_LEN_MAX.
|
936
|
+
# </dd>
|
937
|
+
#
|
938
|
+
# <dt>filter</dt>
|
939
|
+
# <dd>The list of criteria that will constrain the notes being considered
|
940
|
+
# related.
|
941
|
+
# Please note that some of the parameters may be ignored, such as
|
942
|
+
# <em>order</em> and <em>ascending</em>.
|
943
|
+
# </dd>
|
944
|
+
# </dl>
|
945
|
+
class RelatedQuery
|
946
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
947
|
+
NOTEGUID = 1
|
948
|
+
PLAINTEXT = 2
|
949
|
+
FILTER = 3
|
950
|
+
|
951
|
+
FIELDS = {
|
952
|
+
NOTEGUID => {:type => ::Thrift::Types::STRING, :name => 'noteGuid', :optional => true},
|
953
|
+
PLAINTEXT => {:type => ::Thrift::Types::STRING, :name => 'plainText', :optional => true},
|
954
|
+
FILTER => {:type => ::Thrift::Types::STRUCT, :name => 'filter', :class => ::Evernote::EDAM::NoteStore::NoteFilter, :optional => true}
|
955
|
+
}
|
956
|
+
|
957
|
+
def struct_fields; FIELDS; end
|
958
|
+
|
959
|
+
def validate
|
960
|
+
end
|
961
|
+
|
962
|
+
::Thrift::Struct.generate_accessors self
|
963
|
+
end
|
964
|
+
|
965
|
+
# The result of calling findRelated(). The contents of the notes,
|
966
|
+
# notebooks, and tags fields will be in decreasing order of expected
|
967
|
+
# relevance. It is possible that fewer results than requested will be
|
968
|
+
# returned even if there are enough distinct entities in the account
|
969
|
+
# in cases where the relevance is estimated to be low.
|
970
|
+
#
|
971
|
+
# <dl>
|
972
|
+
# <dt>notes</dt>
|
973
|
+
# <dd>If notes have been requested to be included, this will be the
|
974
|
+
# list of notes.</dd>
|
975
|
+
#
|
976
|
+
# <dt>notebooks</dt>
|
977
|
+
# <dd>If notebooks have been requested to be included, this will be the
|
978
|
+
# list of notebooks.</dd>
|
979
|
+
#
|
980
|
+
# <dt>tags</dt>
|
981
|
+
# <dd>If tags have been requested to be included, this will be the list
|
982
|
+
# of tags.</dd>
|
983
|
+
# </dl>
|
984
|
+
#
|
985
|
+
# <dt>containingNotebooks</dt>
|
986
|
+
# <dd>If <code>includeContainingNotebooks</code> is set to <code>true</code>
|
987
|
+
# in the RelatedResultSpec, return the list of notebooks to
|
988
|
+
# to which the returned related notes belong. The notebooks in this
|
989
|
+
# list will occur once per notebook GUID and are represented as
|
990
|
+
# NotebookDescriptor objects.</dd>
|
991
|
+
# </dl>
|
992
|
+
#
|
993
|
+
# <dt>debugInfo</dt>
|
994
|
+
# <dd>NOTE: This should be excluded from the public API.<br /><br />
|
995
|
+
# If <code>includeDebugInfo</code> in RelatedResultSpec is set to
|
996
|
+
# <code>true</code>, this field may contain debug information
|
997
|
+
# if the service decides to do so.</dd>
|
998
|
+
# </dl>
|
999
|
+
class RelatedResult
|
1000
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
1001
|
+
NOTES = 1
|
1002
|
+
NOTEBOOKS = 2
|
1003
|
+
TAGS = 3
|
1004
|
+
CONTAININGNOTEBOOKS = 4
|
1005
|
+
DEBUGINFO = 5
|
1006
|
+
|
1007
|
+
FIELDS = {
|
1008
|
+
NOTES => {:type => ::Thrift::Types::LIST, :name => 'notes', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Note}, :optional => true},
|
1009
|
+
NOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'notebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Notebook}, :optional => true},
|
1010
|
+
TAGS => {:type => ::Thrift::Types::LIST, :name => 'tags', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::Tag}, :optional => true},
|
1011
|
+
CONTAININGNOTEBOOKS => {:type => ::Thrift::Types::LIST, :name => 'containingNotebooks', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Evernote::EDAM::Type::NotebookDescriptor}, :optional => true},
|
1012
|
+
DEBUGINFO => {:type => ::Thrift::Types::STRING, :name => 'debugInfo', :optional => true}
|
1013
|
+
}
|
1014
|
+
|
1015
|
+
def struct_fields; FIELDS; end
|
1016
|
+
|
1017
|
+
def validate
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
::Thrift::Struct.generate_accessors self
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# A description of the thing for which the service will find related
|
1024
|
+
# entities, via findRelated(), together with a description of what
|
1025
|
+
# type of entities and how many you are seeking in the
|
1026
|
+
# RelatedResult.
|
1027
|
+
#
|
1028
|
+
# <dl>
|
1029
|
+
# <dt>maxNotes</dt>
|
1030
|
+
# <dd>Return notes that are related to the query, but no more than
|
1031
|
+
# this many. Any value greater than EDAM_RELATED_MAX_NOTES
|
1032
|
+
# will be silently capped. If you do not set this field, then
|
1033
|
+
# no notes will be returned.</dd>
|
1034
|
+
#
|
1035
|
+
# <dt>maxNotebooks</dt>
|
1036
|
+
# <dd>Return notebooks that are related to the query, but no more than
|
1037
|
+
# this many. Any value greater than EDAM_RELATED_MAX_NOTEBOOKS
|
1038
|
+
# will be silently capped. If you do not set this field, then
|
1039
|
+
# no notebooks will be returned.</dd>
|
1040
|
+
#
|
1041
|
+
# <dt>maxTags</dt>
|
1042
|
+
# <dd>Return tags that are related to the query, but no more than
|
1043
|
+
# this many. Any value greater than EDAM_RELATED_MAX_TAGS
|
1044
|
+
# will be silently capped. If you do not set this field, then
|
1045
|
+
# no tags will be returned.</dd>
|
1046
|
+
# </dl>
|
1047
|
+
#
|
1048
|
+
# <dt>writableNotebooksOnly</dt>
|
1049
|
+
# <dd>Require that all returned related notebooks are writable.
|
1050
|
+
# The user will be able to create notes in all returned notebooks.
|
1051
|
+
# However, individual notes returned may still belong to notebooks
|
1052
|
+
# in which the user lacks the ability to create notes.</dd>
|
1053
|
+
# </dl>
|
1054
|
+
#
|
1055
|
+
# <dt>includeContainingNotebooks</dt>
|
1056
|
+
# <dd>If set to <code>true</code>, return the containingNotebooks field
|
1057
|
+
# in the RelatedResult, which will contain the list of notebooks to
|
1058
|
+
# to which the returned related notes belong.</dd>
|
1059
|
+
# </dl>
|
1060
|
+
#
|
1061
|
+
# <dt>includeDebugInfo</dt>
|
1062
|
+
# <dd>NOTE: This should be excluded from the public API.<br /><br />
|
1063
|
+
# If set to <code>true</code>, indicate that debug information should
|
1064
|
+
# be returned in the 'debugInfo' field of RelatedResult.</dd>
|
1065
|
+
# </dl>
|
1066
|
+
class RelatedResultSpec
|
1067
|
+
include ::Thrift::Struct, ::Thrift::Struct_Union
|
1068
|
+
MAXNOTES = 1
|
1069
|
+
MAXNOTEBOOKS = 2
|
1070
|
+
MAXTAGS = 3
|
1071
|
+
WRITABLENOTEBOOKSONLY = 4
|
1072
|
+
INCLUDECONTAININGNOTEBOOKS = 5
|
1073
|
+
INCLUDEDEBUGINFO = 6
|
1074
|
+
|
1075
|
+
FIELDS = {
|
1076
|
+
MAXNOTES => {:type => ::Thrift::Types::I32, :name => 'maxNotes', :optional => true},
|
1077
|
+
MAXNOTEBOOKS => {:type => ::Thrift::Types::I32, :name => 'maxNotebooks', :optional => true},
|
1078
|
+
MAXTAGS => {:type => ::Thrift::Types::I32, :name => 'maxTags', :optional => true},
|
1079
|
+
WRITABLENOTEBOOKSONLY => {:type => ::Thrift::Types::BOOL, :name => 'writableNotebooksOnly', :optional => true},
|
1080
|
+
INCLUDECONTAININGNOTEBOOKS => {:type => ::Thrift::Types::BOOL, :name => 'includeContainingNotebooks', :optional => true},
|
1081
|
+
INCLUDEDEBUGINFO => {:type => ::Thrift::Types::BOOL, :name => 'includeDebugInfo', :optional => true}
|
1082
|
+
}
|
1083
|
+
|
1084
|
+
def struct_fields; FIELDS; end
|
1085
|
+
|
1086
|
+
def validate
|
1087
|
+
end
|
1088
|
+
|
1089
|
+
::Thrift::Struct.generate_accessors self
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
end
|
1093
|
+
end
|
1094
|
+
end
|