-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.draft.yaml
1265 lines (1265 loc) · 32.8 KB
/
openapi.draft.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.1.0
info:
title: PushPress Platform API
version: 3.0.0
servers:
- url: https://api.pushpress.com
description: production
x-speakeasy-server-id: prod
- url: https://api.pushpressstage.com
description: staging
x-speakeasy-server-id: stage
- url: https://api.pushpressdev.com
description: development
x-speakeasy-server-id: dev
x-speakeasy-timeout: 10000
x-speakeasy-retries:
strategy: backoff
backoff:
initialInterval: 500 # 500 milliseconds
maxInterval: 60000 # 60 seconds
maxElapsedTime: 3600000 # 5 minutes
exponent: 1.5
statusCodes:
- 5XX
retryConnectionErrors: true
x-speakeasy-globals:
parameters:
- name: companyId
in: header
schema:
type: string
x-speakeasy-globals-hidden: true # hide this from individual sdk methods
components:
schemas:
ApiKey:
type: object
properties:
keyUuid:
type: string
apiKey:
type: string
clientUuid:
type: string
name:
type: string
description:
type: string
createdAt:
type: number
expiresAt:
type:
- number
- "null"
required:
- keyUuid
- apiKey
- clientUuid
- name
- description
- createdAt
description: Platform API key
example:
keyUuid: key_asdfghjklqwertyuiop
apiKey: sk_zyxvutsrqponmlkjihgfedcba
clientUuid: client_asdfghjklqwertyuiop
name: My API Key
description: Additional description to add context to the key
createdAt: 1577836800000
App:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the app
name:
type: string
description: Name of the app
description:
type: string
description: Description of the app
created:
type: string
format: date-time
description: Timestamp when the app was created
updated:
type: string
format: date-time
description: Timestamp when the app was last updated
required:
- id
- name
- created
- updated
AppInstall:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the app install
app:
type: string
format: uuid
description: Unique identifier for the app
company:
type: string
format: uuid
description: Unique identifier for the client
status:
type: string
description: Status of the app install
installed:
type: string
format: date-time
description: Timestamp when the app was installed
uninstalled:
type: string
format: date-time
description: Timestamp when the app was uninstalled (nullable)
required:
- id
- app
- company
- status
- installed
Company:
type: object
title: Company
description: Schema representing a company with a pushpress account, whether its a gym, martial arts studio or mermaid swim school
required:
- id
- name
- subdomain
- defaultTimezone
- phone
- email
properties:
id:
type: string
description: Unique identifier for the company
examples:
- "client_1234"
name:
type: string
description: Name of the company
examples:
- "Acme Corp"
subdomain:
type: string
description: Subdomain of the company
examples:
- "acme"
defaultTimezone:
type: string
description: Default timezone of the company
examples:
- "America/Los_Angeles"
phone:
type: string
description: Phone number of the company
examples:
- "+1-800-555-1234"
email:
type: string
description: Email address of the company
examples:
url:
type: string
description: URL of the company
examples:
- "https://www.acme.com"
examples:
- exampleResponse:
value:
id: "client_1234"
name: "Acme Corp"
subdomain: "acme"
defaultTimezone: "America/Los_Angeles"
phone: "+1-800-555-1234"
email: "[email protected]"
url: "https://www.acme.com"
Customer:
type: object
title: Customer
description: Schema representing a customer, former customer or lead served by Company
required:
- id
- email
properties:
id:
type: string
description: Unique identifier for the customer
examples:
- "usr_1234"
name:
type: string
description: Name of the customer
examples:
- "John Doe"
address:
type: string
description: Address of the customer
examples:
- "123 Main St, Anytown, USA"
profileImage:
type: string
description: URL to the profile image of the customer
examples:
- "https://example.com/profile.jpg"
email:
type: string
description: Email address of the customer
examples:
phone:
type: string
description: Phone number of the customer
examples:
- "+1-800-555-1234"
examples:
- exampleResponse:
value:
id: "usr_1234"
name: "John Doe"
email: "[email protected]"
address: "123 Main St, Anytown, USA"
profileImage: "https://example.com/profile.jpg"
phone: "+1-800-555-1234"
deviceToken: "abc123xyz456"
AppointmentCheckin:
type: object
required:
- id
- name
- type
- appointmentType
properties:
id:
type: string
description: Unique identifier for the checkin
name:
type: string
description: Name of the checked-in appointment
type:
type: string
enum: [AppointmentCheckin]
appointmentType:
type: string
description: Type of the appointment
ClassCheckin:
type: object
required:
- id
- name
- type
- classType
properties:
id:
type: string
description: Unique identifier for the checkin
name:
type: string
description: Name of the checked-in class
type:
type: string
enum: [ClassCheckin]
classType:
type: string
description: Type of the class
EventCheckin:
type: object
required:
- id
- name
- type
- eventType
properties:
name:
type: string
description: Name of the checked-in event
type:
type: string
enum: [EventCheckin]
eventType:
type: string
description: Type of the event
Checkin:
type: object
required:
- id
- details
- checkinTime
- customer
- company
- name
properties:
details:
type: object
discriminator:
propertyName: type
oneOf:
- $ref: "#/components/schemas/AppointmentCheckin"
- $ref: "#/components/schemas/ClassCheckin"
- $ref: "#/components/schemas/EventCheckin"
description: Type of the check-in
checkinTime:
type: integer
format: int64
description: Check-in time in Unix timestamp
customer:
type: string
description: Customer ID for the check-in
company:
type: string
description: Company ID for the check-in
name:
type: string
description: Name of the thing being checked in
Webhook:
type: object
required:
- id
- url
- events
- created
- company
- updated
properties:
id:
type: string
examples:
- "UUID"
url:
type: string
description: URL to post the event data to
examples:
- https://new-webhook-url.com
events:
type: array
description: List of events the webhook is subscribed to
items:
type: string
examples:
- ["event_3", "event_4"]
created:
type: number
updated:
type: number
company:
type: string
description: companyId of the company to which the webhook belongs
securitySchemes:
api_key:
type: apiKey
name: API-KEY
in: header
description: >-
Pass the API key as a Bearer token in the `api_key` header. Example: `api_key: <API_KEY>`
security:
- api_key: []
tags:
- name: Messages
- name: Customers
- name: Companies
- name: Checkins
- name: ApiKeys
- name: Apps
description: manage PushPress appl ecosystem
- name: Webhooks
description: create and configure webhooks for PushPress events
paths:
/apps:
get:
tags:
- Apps
summary: List all available apps
operationId: listApps
responses:
"200":
description: Successfully retrieved list of apps
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/App"
x-speakeasy-name-override: list
x-speakeasy-group: apps
/apps/{app_id}:
get:
tags:
- Apps
summary: Get details of a specific app
operationId: getApp
parameters:
- name: app_id
in: path
required: true
schema:
type: string
responses:
"200":
description: Successfully retrieved app details
content:
application/json:
schema:
$ref: "#/components/schemas/App"
x-speakeasy-group: apps
x-speakeasy-name-override: get
/apps/{app_id}/install:
post:
tags:
- Apps
summary: Install an app for a company
operationId: installApp
parameters:
- name: app_id
in: path
required: true
schema:
type: string
- name: companyId
in: header
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
company:
type: string
description: The ID of the company on which to install the app
required:
- company
responses:
"201":
description: Successfully installed the app
x-speakeasy-group: apps
x-speakeasy-name-override: install
/apps/{app_id}/installs:
get:
tags:
- Apps
summary: List all installs of a specific app
operationId: listAppInstalls
parameters:
- name: app_id
in: path
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
default: 1
- name: limit
in: query
required: false
schema:
type: integer
default: 10
minimum: 1
maximum: 100
- name: companyId
in: header
schema:
type: string
responses:
"200":
description: A paginated list of app installs
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: "#/components/schemas/AppInstall"
x-speakeasy-group: apps.installs
x-speakeasy-name-override: list
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: page
in: parameters
type: page
- name: limit
in: parameters
type: limit
outputs:
results: $.data.resultArray
/apps/{app_id}/installs/{install_id}/uninstall:
patch:
tags:
- Apps
summary: Soft uninstall an app (mark it as uninstalled but retain data)
operationId: uninstallApp
parameters:
- name: app_id
in: path
required: true
schema:
type: string
- name: install_id
in: path
required: true
schema:
type: string
- name: companyId
in: header
schema:
type: string
responses:
"204":
description: Successfully soft uninstalled the app
content:
application/json:
schema:
$ref: "#/components/schemas/AppInstall"
x-speakeasy-group: apps
x-speakeasy-name-override: uninstall
/apps/{app_id}/installs/{install_id}/delete:
delete:
tags:
- Apps
summary: Hard delete an app (remove all data)
operationId: deleteAppInstall
parameters:
- name: app_id
in: path
required: true
schema:
type: string
- name: install_id
in: path
required: true
schema:
type: string
- name: companyId
in: header
schema:
type: string
responses:
"204":
description: Successfully hard uninstalled the app
content:
application/json:
schema:
$ref: "#/components/schemas/AppInstall"
x-speakeasy-group: apps
x-speakeasy-name-override: delete
/apps/{app_id}/installs/{install_id}:
get:
tags:
- Apps
summary: Get details of a specific app install
operationId: getAppInstall
parameters:
- name: app_id
in: path
required: true
schema:
type: string
- name: install_id
in: path
required: true
schema:
type: string
- name: companyId
in: header
schema:
type: string
responses:
"200":
description: Successfully retrieved app install details
content:
application/json:
schema:
$ref: "#/components/schemas/AppInstall"
x-speakeasy-name-override: get
x-speakeasy-group: apps.installs
/keys:
post:
tags:
- ApiKeys
summary: Create a new API key for a company
description: Create a new API key for a company.
operationId: createApiKey
parameters:
- name: companyId
in: header
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
company:
type: string
description: The ID of the company for which to create the API key
required:
- company
responses:
"200":
description: API key created successfully
"400":
description: Bad request
x-speakeasy-name-override: create
get:
tags:
- ApiKeys
summary: List all active API keys for a client
description: List all active API keys for a client.
operationId: listApiKeys
responses:
"200":
description: A list of active API keys
content:
application/json:
schema:
$ref: "#/components/schemas/ApiKey"
"400":
description: Bad request
x-speakeasy-name-override: list
/keys/{key_id}/revoke:
patch:
tags:
- ApiKeys
summary: Revoke an API key
description: Revoke (deactivate) an API key.
operationId: revokeApiKey
parameters:
- name: key_id
in: path
required: true
schema:
type: string
responses:
"200":
description: API key revoked successfully
"400":
description: Bad request
x-speakeasy-name-override: revoke
/keys/{key_id}:
get:
tags:
- ApiKeys
summary: Retrieve a single API key
description: Retrieve a single API key.
operationId: getApiKey
parameters:
- name: key_id
in: path
required: true
description: The ID of the API key to retrieve
schema:
type: string
responses:
"200":
description: Successfully retrieved API key
content:
application/json:
schema:
$ref: "#/components/schemas/ApiKey"
x-speakeasy-name-override: get
x-speakeasy-group: keys
delete:
tags:
- ApiKeys
summary: Permanently delete an API key
description: Permanently delete an API key from the system.
operationId: deleteApiKey
parameters:
- name: key_id
in: path
required: true
schema:
type: string
responses:
"204":
description: API key deleted successfully
"400":
description: Bad request
x-speakeasy-name-override: delete
/messages/email/send:
post:
tags:
- Messages
summary: Send an email
operationId: sendEmail
parameters:
- name: companyId
in: header
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- to
- subject
- body
- from
properties:
to:
type: string
format: email
subject:
type: string
body:
type: string
from:
type: string
format: email
cc:
type: string
format: email
bcc:
type: string
format: email
replyTo:
type: string
format: email
responses:
"200":
description: Email sent successfully
"400":
description: Bad request
x-speakeasy-name-override: send
x-speakeasy-group: messages.email
/messages/notifications/ping:
post:
tags:
- Messages
summary: Send a ping notification via Ably Realtime
operationId: sendPing
parameters:
- name: companyId
in: header
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- channel
- message
properties:
channel:
type: string
message:
type: string
responses:
"200":
description: Ping sent successfully
"400":
description: Bad request
x-speakeasy-name-override: sendPing
x-speakeasy-group: messages.notifications
/messages/push/send:
post:
tags:
- Messages
summary: Send a push notification
operationId: sendPush
parameters:
- name: companyId
in: header
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- device_tokens
- title
- body
properties:
device_tokens:
type: array
items:
type: string
title:
type: string
body:
type: string
metadata:
type: object
additionalProperties: true
responses:
"200":
description: Push notification sent successfully
"400":
description: Bad request
x-speakeasy-name-override: send
x-speakeasy-group: messages.push
/company:
get:
tags:
- Companies
summary: Get company details associated with the API key
operationId: getCompany
parameters:
- name: companyId
in: header
schema:
type: string
responses:
"200":
description: Company details
content:
application/json:
schema:
$ref: "#/components/schemas/Company"
x-speakeasy-name-override: get
/customers:
get:
tags:
- Customers
summary: Get a list of all customers in a
operationId: listCustomers
parameters:
- name: companyId
in: header
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
default: 1
- name: limit
in: query
required: false
schema:
type: integer
default: 10
minimum: 1
maximum: 100
responses:
"200":
description: A paginated response containing an array of customerIds
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
description: An array of objects containing customerIds
items:
$ref: "#/components/schemas/Customer"
x-speakeasy-name-override: list
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: page
in: parameters
type: page
- name: limit
in: parameters
type: limit
outputs:
results: $.data.resultArray
/customers/{id}:
get:
tags:
- Customers
summary: Get a customer by ID
operationId: getCustomer
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: companyId
in: header
schema:
type: string
responses:
"200":
description: Customer details
content:
application/json:
schema:
$ref: "#/components/schemas/Customer"
x-speakeasy-name-override: get
/checkins:
get:
tags:
- Checkins
summary: Get a list of all check-ins
operationId: listCheckins
parameters:
- name: companyId
in: header
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
default: 1
- name: limit
in: query
required: false
schema:
type: integer
default: 10
minimum: 1
maximum: 100
responses:
"200":
description: A paginated response containing a list of check-ins
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: "#/components/schemas/Checkin"
x-speakeasy-name-override: list
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: page
in: parameters
type: page
- name: limit
in: parameters
type: limit
outputs:
results: $.data.resultArray
/checkins/{id}:
get:
tags:
- Checkins
summary: Get a check-in by ID
operationId: getCheckin
parameters:
- name: companyId
in: header
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: Check-in details
content:
application/json:
schema:
$ref: "#/components/schemas/Checkin"
x-speakeasy-name-override: get
/webhooks:
post:
tags:
- Webhooks
summary: Create a new webhook to subscribe to one or more events
operationId: createWebhook
parameters:
- name: companyId
in: header
schema:
type: string
requestBody: