forked from XeroAPI/Xero-OpenAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xero_files.yaml
731 lines (731 loc) · 20.4 KB
/
xero_files.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
openapi: 3.0.0
servers:
- description: Xero Files API
url: https://api.xero.com/files.xro/1.0/
info:
title: Xero Files API
version: "2.3.7"
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
contact:
name: "Xero Platform Team"
email: "[email protected]"
url: "https://developer.xero.com"
tags:
- name: Files
description: Operations available to regular developers
paths:
/Files:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
operationId: getFiles
summary: searches files
parameters:
- in: query
name: pagesize
description: pass an optional page size value
schema:
type: integer
maximum: 100
example: 50
- in: query
name: page
description: number of records to skip for pagination
schema:
type: integer
minimum: 1
example: 2
- in: query
name: sort
description: values to sort by
schema:
type: string
enum:
- Name
- Size
- CreatedDateUTC
example: "CreatedDateUTC DESC"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Files'
'400':
description: bad input parameter - TODO
post:
security:
- OAuth2: [files]
tags:
- Files
summary: upload an File
operationId: uploadFile
parameters:
- in: query
name: folderId
description: pass an optional folder id to save file to specific folder
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
'400':
description: invalid input, object invalid - TODO
'409':
description: an existing item already exists - TODO
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
body:
type: string
format: byte
name:
type: string
description: exact name of the file you are uploading
filename:
type: string
mimeType:
type: string
/Files/{FileId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches for file by unique id
operationId: getFile
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
put:
security:
- OAuth2: [files]
tags:
- Files
summary: Update a file
operationId: updateFile
description: Update properties on a single file
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: delete a file
operationId: deleteFile
description: Delete a specific file
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: A successful request returns 204 empty response - populate with status property in SDK
content:
application/json:
schema:
$ref: '#/components/schemas/FileResponse204'
/Files/{FileId}/Content:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches files to retrieve the data
operationId: getFileContent
description: By passing in the appropriate options, retrieve data for specific file
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: returns the byte array of the specific file based on id
content:
application/octet-stream:
schema:
type: string
format: binary
/Files/{FileId}/Associations:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches files
operationId: getFileAssociations
description: |
By passing in the appropriate options,
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Association'
post:
security:
- OAuth2: [files]
tags:
- Files
summary: create a new association
operationId: createFileAssociation
description: By passing in the appropriate options, you can create a new folder
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/Association'
'400':
description: bad input parameter - TODO
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Association'
/Files/{FileId}/Associations/{ObjectId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: create a new association
operationId: deleteFileAssociation
description: By passing in the appropriate options, you can create a new folder
parameters:
- name: FileId
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
- name: ObjectId
in: path
required: true
description: Object id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileResponse204'
'400':
description: bad input parameter - TODO
/Associations/{ObjectId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches files
operationId: getAssociationsByObject
description: By passing in the appropriate options,
parameters:
- name: ObjectId
in: path
required: true
description: Object id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Association'
/Folders:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches folder
operationId: getFolders
description: By passing in the appropriate options, you can search for
available folders
parameters:
- in: query
name: sort
description: values to sort by
schema:
type: string
enum:
- Name
- Size
- CreatedDateUTC
example: "CreatedDateUTC DESC"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Folder'
'400':
description: bad input parameter - TODO
post:
security:
- OAuth2: [files]
tags:
- Files
summary: create a new folder
operationId: createFolder
description: By passing in the appropriate properties, you can create a new folder
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: bad input parameter - TODO
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
/Folders/{FolderId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches specific folder by id
operationId: getFolder
description: By passing in the appropriate ID, you can search for specific folder
parameters:
- name: FolderId
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: bad input parameter - TODO
put:
security:
- OAuth2: [files]
tags:
- Files
summary: update folder
operationId: updateFolder
description: By passing in the appropriate ID and properties, you can update a folder
parameters:
- name: FolderId
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: return the updated object
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: bad input parameter - TODO
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: delete a folder
operationId: deleteFolder
description: By passing in the appropriate ID, you can delete a folder
parameters:
- name: FolderId
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileResponse204'
'400':
description: bad input parameter - TODO
/Inbox:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files.read]
tags:
- Files
summary: searches inbox folder
operationId: getInbox
description: Search for the user inbox
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: bad input parameter - TODO
components:
securitySchemes:
OAuth2:
type: oauth2
description: For more information
flows:
authorizationCode:
authorizationUrl: 'https://login.xero.com/identity/connect/authorize'
tokenUrl: 'https://identity.xero.com/connect/token'
scopes:
email: Grant read-only access to your email
openid: Grant read-only access to your open id
profile: your profile information
files: Grant read-write access to files and folders
files.read: Grant read-only access to files and folders
parameters:
requiredHeader:
in: header
name: xero-tenant-id
description: Xero identifier for Tenant
example: YOUR_XERO_TENANT_ID
schema:
type: string
required: true
schemas:
Files:
type: object
properties:
TotalCount:
type: integer
example: 2
Page:
type: integer
example: 1
PerPage:
type: integer
example: 50
Items:
type: array
items:
$ref: '#/components/schemas/FileObject'
FileObject:
type: object
required:
- id
- name
- manufacturer
- releaseDate
properties:
Name:
description: TODO
type: string
example: File2.jpg
MimeType:
description: TODO
type: string
example: image/jpeg
Size:
description: TODO
type: integer
example: 3615
CreatedDateUTC:
description: TODO
type: string
format: date-time
example: '2014-12-04T23:08:14.0630000'
UpdatedDateUTC:
description: TODO
type: string
format: date-time
example: '2014-12-04T23:08:14.0630000'
User:
$ref: '#/components/schemas/User'
Id:
description: TODO
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
FolderId:
description: TODO
type: string
format: uuid
example: 0f8ccf21-7267-4268-9167-a1e2c40c84c8
User:
required:
- FirstName
- LastName
properties:
UserID:
description: Xero identifier
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
EmailAddress:
description: Email address of user
type: string
example: [email protected]
FirstName:
description: First name of user
type: string
example: John
LastName:
description: Last name of user
type: string
example: Smith
UpdatedDateUTC:
description: Last name of user
type: string
format: date-time
example: Date(1516230549137+0000)
IsSubscriber:
description: Boolean to indicate if user is the subscriber
type: boolean
example: true
OrganisationRole:
description: Boolean to indicate if user is the subscriber
type: string
example: STANDARD
enum:
- READONLY
- INVOICEONLY
- STANDARD
- FINANCIALADVISER
- MANAGEDCLIENT
- CASHBOOKCLIENT
type: object
Folders:
type: object
properties:
Folders:
type: array
items:
$ref: '#/components/schemas/Folder'
Folder:
required:
- name
properties:
Name:
description: The name of the folder
type: string
example: assets
FileCount:
description: The number of files in the folder
type: integer
example: 5
Email:
description: The email address used to email files to the inbox. Only the inbox will have this element.
type: string
example: [email protected]
IsInbox:
description: to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.
type: boolean
example: true
Id:
description: Xero unique identifier for a folder Files
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
Association:
type: object
properties:
FileId:
description: The unique identifier of the file
type: string
format: uuid
ObjectId:
description: The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID)
type: string
format: uuid
ObjectGroup:
$ref: '#/components/schemas/ObjectGroup'
ObjectType:
$ref: '#/components/schemas/ObjectType'
ObjectGroup:
description: The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API.
type: string
enum:
- Account
- BankTransaction
- Contact
- CreditNote
- Invoice
- Item
- ManualJournal
- Overpayment
- Payment
- Prepayment
- Receipt
ObjectType:
description: The Object Type
type: string
enum:
- ACCOUNT
- ACCPAY
- ACCPAYCREDIT
- ACCPAYPAYMENT
- ACCREC
- ACCRECCREDIT
- ACCRECPAYMENT
- ADJUSTMENT
- APCREDITPAYMENT
- APOVERPAYMENT
- APOVERPAYMENTPAYMENT
- APOVERPAYMENTSOURCEPAYMENT
- APPREPAYMENT
- APPREPAYMENTPAYMENT
- APPREPAYMENTSOURCEPAYMENT
- ARCREDITPAYMENT
- AROVERPAYMENT
- AROVERPAYMENTPAYMENT
- AROVERPAYMENTSOURCEPAYMENT
- ARPREPAYMENT
- ARPREPAYMENTPAYMENT
- ARPREPAYMENTSOURCEPAYMENT
- CASHPAID
- CASHREC
- CONTACT
- EXPPAYMENT
- FIXEDASSET
- MANUALJOURNAL
- PAYRUN
- PRICELISTITEM
- PURCHASEORDER
- RECEIPT
- TRANSFER
FileResponse204:
externalDocs:
url: 'https://developer.xero.com/documentation/files-api/files#DELETE'
properties:
Status:
description: Status response for 204 no content
type: string