-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
476 lines (471 loc) · 12.8 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
openapi: 3.1.0
info:
title: Checkin API
version: 0.1.0
description: Checkin API
paths:
/customer:
get:
summary: Customer を取得
tags:
- Customer
operationId: getCustomer
parameters:
- $ref: '#/components/parameters/CustomerId'
- name: traq_id
description: traQ ID
in: query
schema:
type: string
- name: email
description: Email
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
post:
summary: Customer を作成
tags:
- Customer
operationId: postCustomer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostCustomerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
summary: Customer を更新
tags:
- Customer
operationId: patchCustomer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostCustomerRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
'500':
$ref: '#/components/responses/InternalServerError'
/invoice:
post:
summary: Invoice を作成
tags:
- Invoice
operationId: postInvoice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostInvoiceRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
'500':
$ref: '#/components/responses/InternalServerError'
/webhook/invoice-paid:
post:
summary: Webhook の invoice.paid イベントを受け取る
tags:
- Webhook
operationId: postWebhookInvoicePaid
parameters:
- name: Stripe-Signature
description: Stripe が送信する認証情報
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
responses:
'204':
description: No content
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
/list/invoices:
get:
summary: 請求書由来の入金一覧を取得
tags:
- List
operationId: getInvoices
parameters:
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/SubscriptionId'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/StartingAfter'
- $ref: '#/components/parameters/EndingBefore'
- name: status
description: 請求書ステータス
in: query
schema:
type: string
enum:
- draft
- open
- paid
- uncollectible
- void
- name: collection_method
description: 請求書の支払い方法
in: query
schema:
type: string
enum:
- charge_automatically
- send_invoice
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Invoice'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
/list/checkout-sessions:
get:
summary: オンライン決済ページ由来の入金一覧を取得
tags:
- List
operationId: getCheckoutSessions
parameters:
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/SubscriptionId'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/StartingAfter'
- $ref: '#/components/parameters/EndingBefore'
- name: payment_intent_id
description: PaymentIntent ID
in: query
schema:
type: string
- name: status
description: Checkout Session のステータス
in: query
schema:
type: string
enum:
- complete
- expired
- open
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetCheckoutSessionsResponse'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
/admin:
get:
summary: 管理者の一覧を取得
tags:
- Admin
operationId: getAdmins
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Admin'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
post:
summary: 管理者を作成
tags:
- Admin
operationId: postAdmin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: 管理者を削除
tags:
- Admin
operationId: deleteAdmin
parameters:
- name: id
in: query
description: 管理者の traQ ID
required: true
schema:
type: string
responses:
'204':
description: No content
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
components:
parameters:
CustomerId:
name: customer_id
in: query
description: Customer ID
schema:
type: string
example: cus_NeZwdNtLEOXuvB
SubscriptionId:
name: subscription_id
in: query
description: Subscription ID
schema:
type: string
example: sub_NeZwdNtLEOXuvB
Limit:
name: limit
in: query
description: 取得件数
schema:
type: integer
minimum: 1
maximum: 100
default: 10
StartingAfter:
name: starting_after
in: query
description: 指定された ID のオブジェクト以降のオブジェクトを取得
schema:
type: string
EndingBefore:
name: ending_before
in: query
description: 指定された ID のオブジェクト以前のオブジェクトを取得
schema:
type: string
responses:
Forbidden:
description: Forbidden
NotFound:
description: Not found
InternalServerError:
description: Internal server error
schemas:
Admin:
description: 管理者の情報
type: object
properties:
id:
type: string
description: traQ ID
example: traP
required:
- id
Customer:
description: Customer の情報
type: object
properties:
id:
type: string
description: Customer ID
example: cus_NeZwdNtLEOXuvB
traq_id:
type: string
description: traQ ID
example: traP
email:
type: string
description: Email
example: jennyrosen@example.com
name:
type: string
description: Name
example: Jenny Rosen
PostCustomerRequest:
description: Customer 作成リクエスト
type: object
properties:
email:
type: string
description: Email
name:
type: string
description: Name
traq_id:
type: string
description: traQ ID
required:
- email
- name
PostInvoiceRequest:
description: Invoice 作成リクエスト
type: object
properties:
customer_id:
type: string
description: Customer ID
product_id:
type: string
description: Product ID
required:
- customer_id
- product_id
Invoice:
description: Invoice の情報
type: object
properties:
has_more:
type: boolean
description: 次のページがあるか
data:
type: array
items:
type: object
properties:
id:
type: string
description: Invoice ID
example: in_1MtHbELkdIwHu7ixl4OzzPMv
amount_due:
type: integer
description: 最終的に支払う金額
example: 0
amount_paid:
type: integer
description: 支払い済み金額
example: 0
amount_remaining:
type: integer
description: 支払い残高
example: 0
created:
type: integer
description: 作成日時 (Unix 時間)
example: 1680644467
customer:
$ref: '#/components/schemas/Customer'
status:
type: string
description: 請求書ステータス
enum:
- draft
- open
- paid
- uncollectible
- void
example: draft
payment_intent:
type:
- string
description: この請求書に関連付けられた PaymentIntent
example: pi_3MtwBwLkdIwHu7ix28a3tqPa
product_id:
type: string
description: Product ID
example: prod_NWjs8kKbJWmuuc
GetCheckoutSessionsResponse:
description: オンライン決済ページ由来の入金一覧
type: object
properties:
has_more:
type: boolean
description: 次のページがあるか
data:
type: array
items:
type: object
properties:
id:
type: string
description: Checkout Session ID
example: cs_test_1234567890
amount_total:
type: integer
description: 支払い金額
example: 2198
amount_subtotal:
type: integer
description: 割引・税金を含まない支払い金額
example: 1998
created:
type: integer
description: 作成日時 (Unix 時間)
example: 1679600215
customer:
$ref: '#/components/schemas/Customer'
status:
type: string
description: Checkout Session のステータス
enum:
- complete
- expired
- open
example: open
payment_intent:
type:
- string
description: この Checkout Session に関連付けられた PaymentIntent
example: pi_3MtwBwLkdIwHu7ix28a3tqPa
product_id:
type: string
description: Product ID
example: prod_NWjs8kKbJWmuuc
tags:
- name: Customer
description: Customer API
- name: Invoice
description: Invoice API
- name: Webhook
description: Webhook API
- name: List
description: List API
- name: Admin
description: Admin API