-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi-spec.yaml
523 lines (523 loc) · 16.1 KB
/
openapi-spec.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
openapi: 3.0.0
servers:
- url: 'http://127.0.0.1:4010'
description: ''
variables: {}
info:
version: 1x
title: ambianic-cloud-api-collection
description: This collection contains a specification for all API endpoints within Ambianic's Cloud API.
termsOfService: ''
contact: {}
license:
name: ''
paths:
/subscription:
get:
summary: Get a user's subscription data
description: Retrieve a subscribed customer's data from Stripe
operationId: get-subscription-data
parameters:
- $ref: '#/components/parameters/userStripeId'
- $ref: '#/components/parameters/userSubscriptionId'
- name: Access-Control-Allow-Origin
in: header
required: true
style: simple
schema:
type: string
example: '*'
- name: Access-Control-Allow-Headers
in: header
required: true
style: simple
schema:
type: string
example: Content-Type
- name: Content-Type
in: header
required: true
style: simple
schema:
type: string
example: application/json
responses:
'200':
description: ''
content:
application/json:
schema:
description: ''
type: object
properties:
id:
type: string
minLength: 1
object:
type: string
minLength: 1
application_fee_percent: {}
billing_cycle_anchor:
type: number
billing_thresholds: {}
cancel_at: {}
cancel_at_period_end:
type: boolean
canceled_at:
type: number
collection_method:
type: string
minLength: 1
created:
type: number
current_period_end:
type: number
current_period_start:
type: number
customer:
type: string
minLength: 1
days_until_due: {}
default_payment_method: {}
default_source: {}
discount: {}
ended_at:
type: number
latest_invoice: {}
livemode:
type: boolean
metadata:
type: object
properties: {}
next_pending_invoice_item_invoice: {}
pause_collection: {}
pending_invoice_item_interval: {}
pending_setup_intent: {}
pending_update: {}
schedule: {}
start_date:
type: number
status:
type: string
minLength: 1
transfer_data: {}
trial_end:
type: number
trial_start:
type: number
required:
- id
- object
- billing_cycle_anchor
- cancel_at_period_end
- canceled_at
- collection_method
- created
- current_period_end
- current_period_start
- customer
- default_tax_rates
- ended_at
- livemode
- metadata
- start_date
- status
- trial_end
- trial_start
x-examples:
example-1:
id: sub_36VrPHS2vVxJMq
object: subscription
application_fee_percent: null
billing_cycle_anchor: 1387222772
billing_thresholds: null
cancel_at: null
cancel_at_period_end: false
canceled_at: 1445989053
collection_method: charge_automatically
created: 1386790772
current_period_end: 1447702772
current_period_start: 1444678772
customer: cus_36Akh5CetFGg9T
days_until_due: null
default_payment_method: null
default_source: null
default_tax_rates: []
discount: null
ended_at: 1445989053
latest_invoice: null
livemode: false
metadata: {}
next_pending_invoice_item_invoice: null
pause_collection: null
pending_invoice_item_interval: null
pending_setup_intent: null
pending_update: null
schedule: null
start_date: 1386790772
status: canceled
transfer_data: null
trial_end: 1387222772
trial_start: 1386790772
examples:
customer-object:
value:
id: sub_36VrPHS2vVxJMq
object: subscription
application_fee_percent: null
billing_cycle_anchor: 1387222772
billing_thresholds: null
cancel_at: null
cancel_at_period_end: false
canceled_at: 1445989053
collection_method: charge_automatically
created: 1386790772
current_period_end: 1447702772
current_period_start: 1444678772
customer: cus_36Akh5CetFGg9T
days_until_due: null
default_payment_method: null
default_source: null
default_tax_rates: []
discount: null
ended_at: 1445989053
latest_invoice: null
livemode: false
metadata: {}
next_pending_invoice_item_invoice: null
pause_collection: null
pending_invoice_item_interval: null
pending_setup_intent: null
pending_update: null
schedule: null
start_date: 1386790772
status: canceled
transfer_data: null
trial_end: 1387222772
trial_start: 1386790772
delete:
summary: Delete an Ambianic's user subscription
description: 'Delete a user''s subscription on Stripe, either active or expired.'
operationId: delete-subscription
parameters:
- $ref: '#/components/parameters/subscriptionId'
- name: Access-Control-Allow-Origin
in: header
required: true
style: simple
schema:
type: string
example: '*'
- name: Access-Control-Allow-Headers
in: header
required: true
style: simple
schema:
type: string
example: Content-Type
- name: Content-Type
in: header
required: true
style: simple
schema:
type: string
example: application/json
responses:
'200':
description: ''
content:
application/json:
schema:
description: Deleted subscription response
type: object
properties:
id:
type: string
minLength: 1
object:
type: string
minLength: 1
deleted:
type: boolean
examples:
deleted-sub-example:
value:
id: cus_JG7VryYKvr7Bvb
object: subscription
deleted: true
status: canceled
post:
summary: Subscribe a user to Ambianic's Premium Services
description: A POST request to create a new customer under Ambianic and also subscribe user to Ambianic Premium Service
operationId: create-subscription
parameters:
- name: Access-Control-Allow-Origin
in: header
required: true
style: simple
schema:
type: string
example: '*'
responses:
'200':
description: ''
content:
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
userStripeId:
type: string
minLength: 1
userSubscriptionId:
type: string
minLength: 1
required:
- message
- userStripeId
- userSubscriptionId
x-examples:
example-1:
message: NOTIFICATION SUBSCRIPTION CREATED
userStripeId: cus|1234567890
userSubscriptionId: sub|12345678
examples:
subscription-response:
value:
message: NOTIFICATION SUBSCRIPTION CREATED
userStripeId: cus|1234567890
userSubscriptionId: sub|12345678
requestBody:
description: A POST request to create a new customer with Stripe under Ambianic and also subscribe user to Ambianic Premium Service
required: true
content:
multipart/form-data:
schema:
required:
- email
- cvc
- number
- exp_year
- exp_month
properties:
email:
type: string
example: [email protected]
cvc:
type: string
example: '123'
number:
type: string
example: '1234567890'
exp_year:
type: string
example: '2024'
exp_month:
type: string
example: '11'
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
userStripeId:
type: string
minLength: 1
userSubscriptionId:
type: string
minLength: 1
required:
- message
- userStripeId
- userSubscriptionId
x-examples:
example-1:
message: Cat event detected
userStripeId: auth|12345678901
userSubscriptionId: sub|12345678901
examples:
subscription-request:
value:
message: string
userStripeId: string
userSubscriptionId: string
/notification:
post:
summary: Send an event detection notification
description: 'An endpoint to send notifications about detected objects to a premium ambianic subscriber from a running edge device, delivered from the Cloud API.'
operationId: send-notification
parameters:
- $ref: '#/components/parameters/userId'
- $ref: '#/components/parameters/notification'
- name: Access-Control-Allow-Origin
in: header
required: true
style: simple
schema:
type: string
example: '*'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: string
minLength: 1
required:
- message
x-examples:
example-1:
message: Notification sent
examples:
notification-reponse:
summary: A successful notification response
value:
message: Notification sent
requestBody:
content:
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
required:
- message
x-examples:
example-1:
message: Notification Sent
examples: {}
components:
parameters:
number:
name: number
in: query
required: true
style: form
schema:
type: string
example: CREDIT_CARD_NUMBER
description: 16 digit Number on the credit card supplied
cvc:
name: cvc
in: query
required: true
style: form
schema:
type: string
example: CREDIT_CARD_CVC
description: Cvc number behind credit card
exp_month:
name: exp_month
in: query
required: true
style: form
schema:
type: string
example: CREDIT_CARD_EXPIRY_MONTH
description: '2 digit expected credit card expiry month. '
exp_year:
name: exp_year
in: query
required: true
style: form
schema:
type: string
example: CREDIT_CARD_EXPIRY_YEAR
description: '4 digit expected credit card expiry year. '
email:
name: email
in: query
required: true
style: form
schema:
type: string
example: SUBSCRIBER_EMAIL
description: Subscriber's email address
Access-Control-Allow-Origin:
name: Access-Control-Allow-Origin
in: header
required: true
style: simple
schema:
type: string
example: '*'
Access-Control-Allow-Headers:
name: Access-Control-Allow-Headers
in: header
required: true
style: simple
schema:
type: string
example: Content-Type
Content-Type:
name: Content-Type
in: header
required: true
style: simple
schema:
type: string
example: application/json
userStripeId:
name: userStripeId
in: query
required: true
style: form
schema:
type: string
example: STRIPE_CUSTOMER_ID
description: Id for the customer created on Stripe
userSubscriptionId:
name: userSubscriptionId
in: query
required: true
style: form
schema:
type: string
example: CREATED_SUBSCRIPTION_ID
description: Id for the user's subscription with Ambianic
subscriptionId:
name: subscriptionId
in: query
required: true
style: form
schema:
type: string
example: SUBSCRIBER-ID
description: ID for the user's subscription to be deleted
userId:
name: userId
in: query
required: true
style: form
schema:
type: string
example: 'AUTHO_USER_ID '
description: ID of the user that owns the Edge Device triggering the notification
notification:
name: notification
in: query
required: true
style: form
schema:
type: string
example: '{dateTime: "monday"}'
description: Notification object containing detected event details from running ambianic edge device
security: []
tags: []
externalDocs:
url: ''
description: ''