-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
2964 lines (2890 loc) · 92.2 KB
/
openapi.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
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: OfficeRnD
description: Unofficial OfficeRnD specification.
contact:
email: technology-team@techspace.co
license:
name: MIT
url: https://github.com/techspaceco/officernd-api/LICENSE
version: 1.0.0
externalDocs:
description: The OfficeRnD public API is designed to let 3rd party applications communicate with the core OfficeRnD platform.
url: https://developer.officernd.com
servers:
- url: 'https://app.officernd.com/api/v1/organizations/{organization}'
variables:
organization:
description: The organization slug.
default: example
tags:
- name: Offices
description: Office objects represent the separate physical locations in the organization. They are used to separate resources and members in a single organization.
security:
- oauth2:
- 'officernd.api.read'
paths:
/offices:
get:
summary: List
operationId: ListOffices
description: Retrieve all locations in the space.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: name
in: query
required: false
description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Office'
/offices/{officeId}:
get:
summary: Get
operationId: GetOffice
description: Retrieve an individual location.
tags:
- offices
parameters:
- name: officeId
in: path
required: true
description: Primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Office'
/floors:
get:
summary: List
operationId: ListFloors
description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: name
in: query
required: false
description: The exact name of the item you are looking for.
schema:
type: string
- name: office
in: query
required: false
description: Filter by office id.
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Floor'
/floors/{floorId}:
get:
summary: Get
operationId: GetFloor
description: Retrieve an individual floor.
tags:
- floors
parameters:
- name: floorId
in: path
required: true
description: Primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Floor'
/members:
get:
summary: List
operationId: ListMembers
description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: modifiedAt.$gt
in: query
required: false
description: All items created or last modified after the pointed date
schema:
type: string
format: date-time
- name: modifiedAt.$lt
in: query
required: false
description: All items created or last modified before the pointed date
schema:
type: string
format: date-time
- name: createdAt.$gt
in: query
required: false
description: All items created after the pointed date
schema:
type: string
format: date-time
- name: createdAt.$lt
in: query
required: false
description: All items created before the pointed date
schema:
type: string
format: date-time
- name: office
in: query
required: false
description: Filter by office id.
schema:
type: string
- name: team
in: query
required: false
description: Filter by team id.
schema:
type: string
- name: name
in: query
required: false
description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Member'
post:
summary: Create
operationId: CreateMembers
description: Add new members.
tags:
- members
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Member'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Member'
delete:
summary: Delete
operationId: DeleteMembers
description: You can delete members by passing array of IDs to be deleted as request body.
tags:
- members
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: OK
/members/{memberId}:
get:
summary: Get
operationId: GetMember
description: Retrieve an individual member.
tags:
- members
parameters:
- name: memberId
in: path
required: true
description: Primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
put:
summary: Update
operationId: UpdateMember
description: Retrieve an individual member.
tags:
- members
parameters:
- name: memberId
in: path
required: true
description: Primary key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
/teams:
get:
summary: List
operationId: ListTeams
description: Team objects allow you to keep your companies' data in single place, track memberships, invoices, charges, fees, and etc.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: modifiedAt.$gt
in: query
required: false
description: All items created or last modified after the pointed date
schema:
type: string
format: date-time
- name: modifiedAt.$lt
in: query
required: false
description: All items created or last modified before the pointed date
schema:
type: string
format: date-time
- name: createdAt.$gt
in: query
required: false
description: All items created after the pointed date
schema:
type: string
format: date-time
- name: createdAt.$lt
in: query
required: false
description: All items created before the pointed date
schema:
type: string
format: date-time
- name: office
in: query
required: false
description: Filter by office id.
schema:
type: string
- name: name
in: query
required: false
description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
post:
summary: Create
operationId: CreateTeams
description: Add new teams.
tags:
- teams
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
delete:
summary: Delete
operationId: DeleteTeams
description: You can delete teams by passing array of IDs to be deleted as request body.
tags:
- teams
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: OK
/teams/{teamId}:
get:
summary: Get
operationId: GetTeam
description: Retrieve an individual team.
tags:
- teams
parameters:
- name: teamId
in: path
required: true
description: Primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
put:
summary: Update
operationId: UpdateTeam
description: Retrieve an individual team.
tags:
- teams
parameters:
- name: teamId
in: path
required: true
description: Primary key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
/memberships:
get:
summary: List
operationId: ListMemberships
description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: $populate
in: query
required: false
description: Comma-separated list of all properties to be populated. Only id references can be populated. Refer to Populating queries section for more information.
schema:
type: string
- name: team
in: query
required: false
description: Filter by team id.
schema:
type: string
- name: member
in: query
required: false
description: Filter by member id
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
post:
summary: Create
operationId: CreateMemberships
description: Add new memberships.
tags:
- memberships
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
delete:
summary: Delete
operationId: DeleteMemberships
description: You can delete memberships by passing array of IDs to be deleted as request body.
tags:
- memberships
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: OK
/memberships/{membershipId}:
get:
summary: Get
operationId: GetMembership
description: Retrieve an individual membership.
tags:
- memberships
parameters:
- name: membershipId
in: path
required: true
description: Primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
put:
summary: Update
operationId: UpdateMembership
description: Retrieve an individual membership.
tags:
- memberships
parameters:
- name: membershipId
in: path
required: true
description: Primary key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
/checkins:
get:
summary: List
operationId: ListCheckins
description: Represents floor data. Floors are used to classify different resources from the same location. It may contain floorplan data as well.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: modifiedAt.$gt
in: query
required: false
description: All items created or last modified after the pointed date
schema:
type: string
format: date-time
- name: modifiedAt.$lt
in: query
required: false
description: All items created or last modified before the pointed date
schema:
type: string
format: date-time
- name: createdAt.$gt
in: query
required: false
description: All items created after the pointed date
schema:
type: string
format: date-time
- name: createdAt.$lt
in: query
required: false
description: All items created before the pointed date
schema:
type: string
format: date-time
- name: office
in: query
required: false
description: Filter by office id.
schema:
type: string
- name: team
in: query
required: false
description: Filter by team id.
schema:
type: string
- name: name
in: query
required: false
description: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match https://developer.officernd.com/#Wildcard-matches.
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Checkin'
/checkins/{memberId}:
post:
summary: Create
operationId: CreateCheckins
description: |
Check in member with id = {memberId}.
By default, the request checks in the member with start date now, no end date and the office where the member is registered.
You can optionally provide start, end and office in the request body. Member checkins with start date before the current date and no end date are not allowed.
tags:
- checkins
parameters:
- name: memberId
in: path
required: true
description: Member primary key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Checkin'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Checkin'
/checkins/checkout/{memberId}:
post:
summary: Create
operationId: CreateCheckinCheckout
description: |
Check out member with id = {memberId}.
The request will update current checkins end date with now if the checkins don't have an end date.
tags:
- checkins
parameters:
- name: memberId
in: path
required: true
description: Member primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Checkin'
/bookings:
get:
summary: List
operationId: ListBookings
description: Retrieve all bookings.
tags:
- offices
parameters:
- $ref: '#/components/parameters/LimitParam'
- $ref: '#/components/parameters/NextParam'
- $ref: '#/components/parameters/PrevParam'
- name: office
in: query
required: false
description: Filter by office id.
schema:
type: string
- name: member
in: query
required: false
description: Filter by member id.
schema:
type: string
- name: team
in: query
required: false
description: Filter by team id.
schema:
type: string
- name: seriesStart.$gte
in: query
required: false
description: "Filter by start date of the booking series. (UNDOCUMENTED: We think ISO 8601 Date or DateTime)"
schema:
type: string
- name: seriesEnd.$lte
in: query
required: false
description: "Filter by end date of the booking series. (UNDOCUMENTED: We think ISO 8601 Date or DateTime)"
schema:
type: string
responses:
'200':
description: OK
headers:
rnd-cursor-next:
$ref: '#/components/headers/rnd-cursor-next'
rnd-cursor-prev:
$ref: '#/components/headers/rnd-cursor-prev'
rnd-range-start:
$ref: '#/components/headers/rnd-range-start'
rnd-range-end:
$ref: '#/components/headers/rnd-range-end'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
post:
summary: Create
operationId: CreateBookings
description: Add one or many bookings.
tags:
- bookings
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
/bookings/checkout:
post:
summary: Create
operationId: CreateBookingsCheckout
description: |
Create bookings without specifying resources, but search parameters instead.
tags:
- checkins
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
required:
- start
- end
- count
properties:
start:
type: string
format: date-time
description: Start datetime of the booking request.
end:
type: string
format: date-time
description: End datetime of the booking request.
team:
type: string
description: Reference to the company (required if no member).
member:
type: string
description: Reference to the member (required if no team).
extras:
type: object
description: Dictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra.
source:
type: string
description: The origin/source of the bookings.
summary:
type: string
description: Booking title/summary.
description:
type: string
description: Long description of the booking.
tentative:
type: boolean
description: True if the booking is not confirmed. Tentative bookings are not charged.
free:
type: boolean
description: True if the booking is marked as free. If a booking is marked as free, no fees will be added for it.
size:
type: number
description: The resource size to be used.
count:
type: number
description: The count of bookings of this type to be made.
rate:
type: string
description: The resource rate to be used to lookup available resources.
resourceType:
type: string
description: The resource type to be used to lookup available resources.
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
/bookings/{bookingId}:
get:
summary: Get
operationId: GetBooking
description: Retrieve a booking.
tags:
- offices
parameters:
- name: bookingId
in: path
required: true
description: Booking primary key.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
put:
summary: Update
operationId: UpdateBooking
description: Update a single booking.
tags:
- bookings
parameters:
- name: bookingId
in: path
required: true
description: Booking primary key.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Booking'
delete:
summary: Delete
operationId: DeleteBooking
description: Deleting the booking will remove the associated fees and will return the used credits the the company/member account.
tags:
- bookings
parameters:
- name: bookingId
in: path
required: true
description: Booking primary key.
schema:
type: string
responses:
'200':
description: OK
/bookings/{bookingId}/cancel:
post:
summary: Cancel
operationId: CancelBooking
description: |
Cancel a booking that was already confirmed. Booking cancellation may trigger a notification or generate a cancellation fee based on the cancellation policy.
If you want to suppress those, you should use the silent and skipCancellationPolicy query string parameters.
tags:
- bookings
parameters:
- name: bookingId
in: path
required: true
description: Booking primary key.
schema:
type: string
- name: silent
in: query
required: false
description: Whether to send notifications to the member. If true, a notification will be sent. If false or not passed at all, the notification will be sent as normal.
schema:
type: boolean
- name: skipCancellationPolicy
in: query
required: false
description: Whether to calculate a cancellation fee. If true, the cancellation fee will be skipped. If false or not passed at all, a cancellation fee will be generated based on the cancellation policy for the resource.
schema:
type: boolean
responses:
'200':
description: OK
# TODO: /bookings/summary
# TODO: /bookings/checkout-summary
/bookings/occurrences:
get:
summary: List
operationId: ListBookingOccurrences
description: Get a list of all occurrences for a specified period.
tags:
- offices
parameters: