cpaas_test_ruby 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +7 -0
  2. data/.devcontainer/devcontainer.json +38 -0
  3. data/.devcontainer/docker/ruby/Dockerfile +39 -0
  4. data/.devcontainer/docker-compose.yml +17 -0
  5. data/.devcontainer/lifecycle/initialize-command.sh +6 -0
  6. data/.rspec +3 -0
  7. data/.rubocop.yml +34 -0
  8. data/.vscode/launch.json +32 -0
  9. data/Gemfile +6 -0
  10. data/LICENSE +21 -0
  11. data/README.md +2 -0
  12. data/Rakefile +8 -0
  13. data/lib/cpaas_test_ruby/config.rb +78 -0
  14. data/lib/cpaas_test_ruby/exception/bad_request_exception.rb +10 -0
  15. data/lib/cpaas_test_ruby/exception/bulk_message_create_failed_exception.rb +9 -0
  16. data/lib/cpaas_test_ruby/exception/bulk_message_list_message_retry_limit_exceed_exception.rb +9 -0
  17. data/lib/cpaas_test_ruby/exception/bulk_message_show_retry_limit_exceed_exception.rb +9 -0
  18. data/lib/cpaas_test_ruby/exception/file_download_failed_exception.rb +9 -0
  19. data/lib/cpaas_test_ruby/exception/file_not_found_exception.rb +9 -0
  20. data/lib/cpaas_test_ruby/exception/file_upload_failed_exception.rb +9 -0
  21. data/lib/cpaas_test_ruby/exception/forbidden_exception.rb +10 -0
  22. data/lib/cpaas_test_ruby/exception/invalid_params_exception.rb +9 -0
  23. data/lib/cpaas_test_ruby/exception/invalid_request_options_exception.rb +9 -0
  24. data/lib/cpaas_test_ruby/exception/karaden_exception.rb +15 -0
  25. data/lib/cpaas_test_ruby/exception/not_found_exception.rb +10 -0
  26. data/lib/cpaas_test_ruby/exception/too_many_requests_exception.rb +10 -0
  27. data/lib/cpaas_test_ruby/exception/unauthorized_exception.rb +10 -0
  28. data/lib/cpaas_test_ruby/exception/unexpected_value_exception.rb +9 -0
  29. data/lib/cpaas_test_ruby/exception/unknown_error_exception.rb +9 -0
  30. data/lib/cpaas_test_ruby/exception/unprocessable_entity_exception.rb +10 -0
  31. data/lib/cpaas_test_ruby/model/bulk_file.rb +34 -0
  32. data/lib/cpaas_test_ruby/model/bulk_message.rb +53 -0
  33. data/lib/cpaas_test_ruby/model/collection.rb +15 -0
  34. data/lib/cpaas_test_ruby/model/error.rb +19 -0
  35. data/lib/cpaas_test_ruby/model/karaden_object.rb +31 -0
  36. data/lib/cpaas_test_ruby/model/message.rb +134 -0
  37. data/lib/cpaas_test_ruby/model/requestable.rb +29 -0
  38. data/lib/cpaas_test_ruby/net/no_contents_response.rb +80 -0
  39. data/lib/cpaas_test_ruby/net/requestor.rb +55 -0
  40. data/lib/cpaas_test_ruby/net/requestor_interface.rb +9 -0
  41. data/lib/cpaas_test_ruby/net/response.rb +79 -0
  42. data/lib/cpaas_test_ruby/net/response_interface.rb +25 -0
  43. data/lib/cpaas_test_ruby/param/message/bulk/bulk_message_create_params.rb +78 -0
  44. data/lib/cpaas_test_ruby/param/message/bulk/bulk_message_download_params.rb +126 -0
  45. data/lib/cpaas_test_ruby/param/message/bulk/bulk_message_list_message_params.rb +72 -0
  46. data/lib/cpaas_test_ruby/param/message/bulk/bulk_message_params.rb +15 -0
  47. data/lib/cpaas_test_ruby/param/message/bulk/bulk_message_show_params.rb +72 -0
  48. data/lib/cpaas_test_ruby/param/message/message_cancel_params.rb +70 -0
  49. data/lib/cpaas_test_ruby/param/message/message_create_params.rb +152 -0
  50. data/lib/cpaas_test_ruby/param/message/message_detail_params.rb +70 -0
  51. data/lib/cpaas_test_ruby/param/message/message_list_params.rb +106 -0
  52. data/lib/cpaas_test_ruby/param/message/message_params.rb +12 -0
  53. data/lib/cpaas_test_ruby/request_options.rb +142 -0
  54. data/lib/cpaas_test_ruby/service/bulk_message_service.rb +90 -0
  55. data/lib/cpaas_test_ruby/utility.rb +65 -0
  56. data/lib/cpaas_test_ruby.rb +51 -0
  57. data/mock/2023-01-01.yaml +776 -0
  58. data/mock/2023-12-01.yaml +783 -0
  59. data/mock/2024-03-01.yaml +1061 -0
  60. data/mock/latest +1 -0
  61. data/package-lock.json +3474 -0
  62. data/package.json +21 -0
  63. data/sig/karaden.rbs +0 -0
  64. metadata +197 -0
@@ -0,0 +1,783 @@
1
+ openapi: 3.0.3
2
+ x-stoplight:
3
+ id: 86da2euinng2g
4
+ info:
5
+ title: Karaden API
6
+ description: This is a Karaden API based on the OpenAPI 3.0 specification.
7
+ version: '2023-12-01'
8
+ servers:
9
+ - url: 'http://localhost/api'
10
+ - url: 'https://dev.cpaas-karaden.com/api'
11
+ components:
12
+ securitySchemes:
13
+ Bearer:
14
+ type: http
15
+ scheme: bearer
16
+ description: APIにアクセスするためのアクセストークンです。
17
+ schemas:
18
+ Message:
19
+ type: object
20
+ x-internal: true
21
+ description: ''
22
+ title: メッセージ
23
+ x-examples:
24
+ example-1:
25
+ id: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
26
+ object: message
27
+ service_id: 1
28
+ billing_address_id: 1
29
+ to: '09012345678'
30
+ body: 本文
31
+ tags:
32
+ - string
33
+ is_shorten: true
34
+ is_shorten_clicked: true
35
+ result: done
36
+ status: done
37
+ sent_result: none
38
+ carrier: docomo
39
+ charged_count_per_sent: 0
40
+ scheduled_at: '2020-01-31T23:59:59+09:00'
41
+ limited_at: '2020-01-31T23:59:59+09:00'
42
+ sent_at: '2020-01-31T23:59:59+09:00'
43
+ received_at: '2020-01-31T23:59:59+09:00'
44
+ charged_at: '2020-01-31T23:59:59+09:00'
45
+ created_at: '2020-01-31T23:59:59+09:00'
46
+ updated_at: '2020-01-31T23:59:59+09:00'
47
+ properties:
48
+ id:
49
+ type: string
50
+ example: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
51
+ description: メッセージID
52
+ format: uuid
53
+ readOnly: true
54
+ object:
55
+ type: string
56
+ default: message
57
+ example: message
58
+ description: オブジェクトの型
59
+ enum:
60
+ - message
61
+ readOnly: true
62
+ service_id:
63
+ type: integer
64
+ example: 1
65
+ description: サービス設定ID
66
+ billing_address_id:
67
+ type: integer
68
+ description: 請求先ID
69
+ example: 1
70
+ readOnly: true
71
+ to:
72
+ type: string
73
+ example: '09012345678'
74
+ description: 送信先電話番号
75
+ pattern: '^[0-9]{11}$'
76
+ body:
77
+ type: string
78
+ example: 本文
79
+ description: 本文
80
+ tags:
81
+ type: array
82
+ description: タグ
83
+ items:
84
+ type: string
85
+ readOnly: true
86
+ 'tags[]':
87
+ type: array
88
+ description: |
89
+ タグ
90
+ items:
91
+ type: string
92
+ writeOnly: true
93
+ is_shorten:
94
+ type: boolean
95
+ description: 短縮URL
96
+ is_shorten_clicked:
97
+ type: boolean
98
+ description: 短縮URLへのアクセス有無
99
+ result:
100
+ type: string
101
+ enum:
102
+ - done
103
+ - processing
104
+ description: 結果
105
+ readOnly: true
106
+ status:
107
+ type: string
108
+ enum:
109
+ - done
110
+ - waiting
111
+ - error
112
+ - canceled
113
+ description: 状態
114
+ readOnly: true
115
+ sent_result:
116
+ type: string
117
+ enum:
118
+ - none
119
+ - received
120
+ - unconnected
121
+ - error
122
+ - unknown
123
+ description: 送達結果
124
+ readOnly: true
125
+ carrier:
126
+ type: string
127
+ enum:
128
+ - docomo
129
+ - softbank
130
+ - au
131
+ - rakuten
132
+ - checking
133
+ - unknown
134
+ description: キャリア
135
+ readOnly: true
136
+ charged_count_per_sent:
137
+ type: integer
138
+ description: 課金対象通数
139
+ example: 1
140
+ readOnly: true
141
+ scheduled_at:
142
+ type: string
143
+ example: '2020-01-31T23:59:59+09:00'
144
+ description: 送信予定日時<br>(ISO 8601形式)
145
+ format: date-time
146
+ limited_at:
147
+ example: '2020-01-31T23:59:59+09:00'
148
+ description: 送信限度日時<br>(ISO 8601形式)
149
+ format: date-time
150
+ type: string
151
+ sent_at:
152
+ type: string
153
+ example: '2020-01-31T23:59:59+09:00'
154
+ description: 送信日時<br>(ISO 8601形式)
155
+ format: date-time
156
+ readOnly: true
157
+ received_at:
158
+ type: string
159
+ example: '2020-01-31T23:59:59+09:00'
160
+ description: 着信日時<br>(ISO 8601形式)
161
+ format: date-time
162
+ readOnly: true
163
+ charged_at:
164
+ type: string
165
+ example: '2020-01-31T23:59:59+09:00'
166
+ description: 課金確定日時<br>(ISO 8601形式)
167
+ format: date-time
168
+ readOnly: true
169
+ created_at:
170
+ type: string
171
+ example: '2020-01-31T23:59:59+09:00'
172
+ description: 受付日時<br>(ISO 8601形式)
173
+ format: date-time
174
+ readOnly: true
175
+ updated_at:
176
+ type: string
177
+ description: 更新日時<br>(ISO 8601形式)
178
+ format: date-time
179
+ example: '2020-01-31T23:59:59+09:00'
180
+ readOnly: true
181
+ required:
182
+ - service_id
183
+ - to
184
+ - body
185
+ SentMessage:
186
+ type: object
187
+ x-internal: true
188
+ description: ''
189
+ title: メッセージ
190
+ x-examples:
191
+ example-1:
192
+ id: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
193
+ object: message
194
+ service_id: 1
195
+ billing_address_id: 1
196
+ to: '09012345678'
197
+ body: 本文
198
+ tags:
199
+ - string
200
+ is_shorten: true
201
+ is_shorten_clicked: true
202
+ result: done
203
+ status: done
204
+ sent_result: none
205
+ carrier: docomo
206
+ charged_count_per_sent: 0
207
+ scheduled_at: '2020-01-31T23:59:59+09:00'
208
+ limited_at: '2020-01-31T23:59:59+09:00'
209
+ sent_at: '2020-01-31T23:59:59+09:00'
210
+ received_at: '2020-01-31T23:59:59+09:00'
211
+ charged_at: '2020-01-31T23:59:59+09:00'
212
+ created_at: '2020-01-31T23:59:59+09:00'
213
+ updated_at: '2020-01-31T23:59:59+09:00'
214
+ properties:
215
+ id:
216
+ type: string
217
+ example: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
218
+ description: メッセージID
219
+ format: uuid
220
+ object:
221
+ type: string
222
+ default: message
223
+ example: message
224
+ description: オブジェクトの型
225
+ enum:
226
+ - message
227
+ service_id:
228
+ type: integer
229
+ example: 1
230
+ description: サービス設定ID
231
+ billing_address_id:
232
+ type: integer
233
+ description: 請求先ID
234
+ example: 1
235
+ to:
236
+ type: string
237
+ example: '09012345678'
238
+ description: 送信先電話番号
239
+ pattern: '^[0-9]{11}$'
240
+ readOnly: true
241
+ body:
242
+ type: string
243
+ example: 本文
244
+ description: 本文
245
+ readOnly: true
246
+ tags:
247
+ type: array
248
+ description: タグ
249
+ items:
250
+ type: string
251
+ is_shorten:
252
+ type: boolean
253
+ description: 短縮URL
254
+ result:
255
+ type: string
256
+ enum:
257
+ - done
258
+ - processing
259
+ description: 結果
260
+ status:
261
+ type: string
262
+ enum:
263
+ - done
264
+ - waiting
265
+ - error
266
+ - canceled
267
+ description: 状態
268
+ sent_result:
269
+ type: string
270
+ enum:
271
+ - none
272
+ - received
273
+ - unconnected
274
+ - error
275
+ - unknown
276
+ description: 送達結果
277
+ carrier:
278
+ type: string
279
+ enum:
280
+ - docomo
281
+ - softbank
282
+ - au
283
+ - rakuten
284
+ - checking
285
+ - unknown
286
+ description: キャリア
287
+ charged_count_per_sent:
288
+ type: integer
289
+ description: 課金対象通数
290
+ example: 1
291
+ scheduled_at:
292
+ type: string
293
+ example: '2020-01-31T23:59:59+09:00'
294
+ description: 送信予定日時<br>(ISO 8601形式)
295
+ format: date-time
296
+ limited_at:
297
+ example: '2020-01-31T23:59:59+09:00'
298
+ description: 送信限度日時<br>(ISO 8601形式)
299
+ format: date-time
300
+ type: string
301
+ sent_at:
302
+ type: string
303
+ example: '2020-01-31T23:59:59+09:00'
304
+ description: 送信日時<br>(ISO 8601形式)
305
+ format: date-time
306
+ received_at:
307
+ type: string
308
+ example: '2020-01-31T23:59:59+09:00'
309
+ description: 着信日時<br>(ISO 8601形式)
310
+ format: date-time
311
+ charged_at:
312
+ type: string
313
+ example: '2020-01-31T23:59:59+09:00'
314
+ description: 課金確定日時<br>(ISO 8601形式)
315
+ format: date-time
316
+ created_at:
317
+ type: string
318
+ example: '2020-01-31T23:59:59+09:00'
319
+ description: 受付日時<br>(ISO 8601形式)
320
+ format: date-time
321
+ updated_at:
322
+ type: string
323
+ description: 更新日時<br>(ISO 8601形式)
324
+ readOnly: true
325
+ required:
326
+ - id
327
+ - object
328
+ - service_id
329
+ - billing_address_id
330
+ - to
331
+ - body
332
+ - result
333
+ - status
334
+ - sent_result
335
+ - carrier
336
+ - charged_count_per_sent
337
+ - created_at
338
+ - updated_at
339
+ Error:
340
+ type: object
341
+ x-internal: true
342
+ x-examples:
343
+ validation_error:
344
+ object: error
345
+ code: validation_error
346
+ message: バリデーションエラーが発生しました
347
+ errors:
348
+ key:
349
+ - エラー詳細1
350
+ - エラー詳細2
351
+ title: エラー
352
+ properties:
353
+ object:
354
+ type: string
355
+ default: error
356
+ example: error
357
+ description: オブジェクトの型
358
+ enum:
359
+ - error
360
+ readOnly: true
361
+ code:
362
+ type: string
363
+ description: エラーコード
364
+ enum:
365
+ - unauthentication
366
+ - invalid_tenant
367
+ - model_not_found
368
+ - validation_error
369
+ - can_not_cancel_message
370
+ - unknown
371
+ readOnly: true
372
+ message:
373
+ type: string
374
+ description: エラーメッセージ
375
+ readOnly: true
376
+ errors:
377
+ type: object
378
+ example:
379
+ key:
380
+ - エラー詳細1
381
+ - エラー詳細2
382
+ description: |-
383
+ エラーの詳細をエラーが発生したリソースのプロパティ毎に返します。<br />
384
+ オブジェクトのプロパティ名は、エラーが発生したリソースのプロパティ名です。<br />
385
+ オブジェクトの値は、発生したすべてのエラーメッセージ(配列)です。
386
+ readOnly: true
387
+ required:
388
+ - object
389
+ - code
390
+ - message
391
+ parameters:
392
+ ApiVersion:
393
+ name: Karaden-Version
394
+ in: header
395
+ schema:
396
+ type: string
397
+ default: '2023-12-01'
398
+ example: '2023-12-01'
399
+ description: APIバージョン<br />指定されない場合、空電で管理するAPIバージョンで処理されます。
400
+ TenantId:
401
+ name: tenant_id
402
+ in: path
403
+ required: true
404
+ schema:
405
+ type: string
406
+ format: uuid
407
+ description: テナントID
408
+ MessageId:
409
+ name: message_id
410
+ in: path
411
+ required: true
412
+ schema:
413
+ type: string
414
+ format: uuid
415
+ description: メッセージID
416
+ Page:
417
+ name: page
418
+ in: query
419
+ required: false
420
+ schema:
421
+ type: integer
422
+ example: 1
423
+ description: ページ
424
+ PerPage:
425
+ name: per_page
426
+ in: query
427
+ required: false
428
+ schema:
429
+ type: integer
430
+ default: 20
431
+ maximum: 100
432
+ description: 1ページあたりの取得件数<br>最大100まで
433
+ Status:
434
+ name: status
435
+ in: query
436
+ schema:
437
+ type: string
438
+ enum:
439
+ - done
440
+ - waiting
441
+ - error
442
+ - canceled
443
+ description: '状態<br>done: 送信済<br>waiting: 送信待ち<br>error: 送信エラー<br>canceled: 送信キャンセル'
444
+ Result:
445
+ name: result
446
+ in: query
447
+ required: false
448
+ schema:
449
+ type: string
450
+ enum:
451
+ - done
452
+ - processing
453
+ description: '結果<br>done: 完了<br>processing: 処理中'
454
+ SentResult:
455
+ name: sent_result
456
+ in: query
457
+ schema:
458
+ type: string
459
+ enum:
460
+ - none
461
+ - received
462
+ - unconnected
463
+ - error
464
+ - unknown
465
+ description: '送達結果<br>none: 送達結果なし<br>received: 着信済<br>unconnected: 圏外<br>error: エラー<br>unknown: 不明'
466
+ security:
467
+ - Bearer: []
468
+ paths:
469
+ '/{tenant_id}/messages':
470
+ post:
471
+ tags:
472
+ - メッセージ
473
+ summary: メッセージ送信
474
+ description: メッセージ送信する
475
+ operationId: post-tenant_id-messages-message_id
476
+ consumes:
477
+ - application/x-www-form-urlencoded
478
+ produces:
479
+ - application/json
480
+ parameters:
481
+ - $ref: '#/components/parameters/ApiVersion'
482
+ responses:
483
+ '200':
484
+ description: 正常
485
+ content:
486
+ application/json:
487
+ schema:
488
+ $ref: '#/components/schemas/Message'
489
+ examples:
490
+ example-1:
491
+ value:
492
+ id: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
493
+ object: message
494
+ service_id: 1
495
+ billing_address_id: 1
496
+ to: '09012345678'
497
+ body: 本文
498
+ tags:
499
+ - string
500
+ is_shorten: true
501
+ is_shorten_clicked: true
502
+ result: done
503
+ status: done
504
+ sent_result: none
505
+ carrier: docomo
506
+ charged_count_per_sent: 0
507
+ scheduled_at: '2020-01-31T23:59:59+09:00'
508
+ limited_at: '2020-01-31T23:59:59+09:00'
509
+ sent_at: '2020-01-31T23:59:59+09:00'
510
+ received_at: '2020-01-31T23:59:59+09:00'
511
+ charged_at: '2020-01-31T23:59:59+09:00'
512
+ created_at: '2020-01-31T23:59:59+09:00'
513
+ updated_at: '2020-01-31T23:59:59+09:00'
514
+ '400':
515
+ description: Bad Request
516
+ content:
517
+ application/json:
518
+ schema:
519
+ $ref: '#/components/schemas/Error'
520
+ examples:
521
+ invalid_tenant:
522
+ value:
523
+ object: error
524
+ code: invalid_tenant
525
+ message: 不正なテナントIDが指定されています
526
+ errors: null
527
+ invalid_version:
528
+ value:
529
+ object: error
530
+ code: invalid_version
531
+ message: 不正なバージョンが指定されています
532
+ errors: null
533
+ '401':
534
+ description: Unauthorized
535
+ content:
536
+ application/json:
537
+ schema:
538
+ $ref: '#/components/schemas/Error'
539
+ examples:
540
+ unauthentication:
541
+ value:
542
+ object: error
543
+ code: unauthentication
544
+ message: 認証に失敗しました、指定されているトークンは利用できません
545
+ errors: null
546
+ '404':
547
+ description: Not Found
548
+ content:
549
+ application/json:
550
+ schema:
551
+ $ref: '#/components/schemas/Error'
552
+ examples:
553
+ model_not_found:
554
+ value:
555
+ object: error
556
+ code: model_not_found
557
+ message: 対象となるモデルが見つかりませんでした、または指定されたトークンでは操作できない可能性があります。
558
+ errors: null
559
+ '422':
560
+ description: Unprocessable Entity
561
+ content:
562
+ application/json:
563
+ schema:
564
+ $ref: '#/components/schemas/Error'
565
+ examples:
566
+ validation_error:
567
+ value:
568
+ object: error
569
+ code: validation_error
570
+ message: バリデーションエラーが発生しました
571
+ errors:
572
+ key:
573
+ - エラー詳細1
574
+ - エラー詳細2
575
+ '500':
576
+ description: Internal Server Error
577
+ content:
578
+ application/json:
579
+ schema:
580
+ $ref: '#/components/schemas/Error'
581
+ examples:
582
+ unknown:
583
+ value:
584
+ object: error
585
+ code: unknown
586
+ message: 不明なエラーが発生しました
587
+ errors: null
588
+ requestBody:
589
+ content:
590
+ application/x-www-form-urlencoded:
591
+ schema:
592
+ $ref: '#/components/schemas/Message'
593
+ examples:
594
+ example-1:
595
+ value:
596
+ id: 999
597
+ object: message
598
+ service_id: 999
599
+ to: 0
600
+ body: 本文
601
+ 'tags[]':
602
+ - タグ1
603
+ - タグ2
604
+ scheduled_at: '2020-01-31T23:59:59+09:00'
605
+ encoding:
606
+ 'tags[]':
607
+ style: form
608
+ explode: true
609
+ description: ''
610
+ get:
611
+ tags:
612
+ - メッセージ
613
+ summary: メッセージ取得(一覧)
614
+ description: メッセージ取得(一覧)する
615
+ operationId: get-tenant_id-messages
616
+ responses:
617
+ '200':
618
+ description: OK
619
+ content:
620
+ application/json:
621
+ schema:
622
+ type: object
623
+ properties:
624
+ object:
625
+ type: string
626
+ default: list
627
+ example: list
628
+ description: オブジェクトの型
629
+ readOnly: true
630
+ has_more:
631
+ type: boolean
632
+ data:
633
+ type: array
634
+ uniqueItems: true
635
+ description: 取得したデータ
636
+ items:
637
+ $ref: '#/components/schemas/Message'
638
+ readOnly: true
639
+ required:
640
+ - object
641
+ - has_more
642
+ - data
643
+ readOnly: true
644
+ examples:
645
+ example-1:
646
+ value:
647
+ object: list
648
+ has_more: true
649
+ data:
650
+ - id: 82bdf9de-a532-4bf5-86bc-c9a1366e5f4a
651
+ object: message
652
+ service_id: 1
653
+ billing_address_id: 1
654
+ to: '09012345678'
655
+ body: 本文
656
+ tags:
657
+ - string
658
+ is_shorten: true
659
+ is_shorten_clicked: true
660
+ result: done
661
+ status: done
662
+ sent_result: none
663
+ carrier: docomo
664
+ charged_count_per_sent: 0
665
+ scheduled_at: '2020-01-31T23:59:59+09:00'
666
+ limited_at: '2020-01-31T23:59:59+09:00'
667
+ sent_at: '2020-01-31T23:59:59+09:00'
668
+ received_at: '2020-01-31T23:59:59+09:00'
669
+ charged_at: '2020-01-31T23:59:59+09:00'
670
+ created_at: '2020-01-31T23:59:59+09:00'
671
+ updated_at: '2020-01-31T23:59:59+09:00'
672
+ parameters:
673
+ - $ref: '#/components/parameters/ApiVersion'
674
+ - schema:
675
+ type: integer
676
+ example: 1
677
+ in: query
678
+ name: service_id
679
+ description: サービス設定ID
680
+ - schema:
681
+ type: string
682
+ example: '09012345678'
683
+ in: query
684
+ name: to
685
+ description: 送信先番号
686
+ - $ref: '#/components/parameters/Status'
687
+ - $ref: '#/components/parameters/Result'
688
+ - $ref: '#/components/parameters/SentResult'
689
+ - schema:
690
+ type: string
691
+ in: query
692
+ name: tag
693
+ description: タグ
694
+ - schema:
695
+ type: string
696
+ format: date-time
697
+ example: '2020-01-31T23:59:59+09:00'
698
+ in: query
699
+ name: start_at
700
+ description: 受付日時(開始)<br>(ISO 8601形式)
701
+ - schema:
702
+ type: string
703
+ format: date-time
704
+ example: '2020-01-31T23:59:59+09:00'
705
+ in: query
706
+ name: end_at
707
+ description: 受付日時(終了)<br>(ISO 8601形式)
708
+ - $ref: '#/components/parameters/Page'
709
+ - $ref: '#/components/parameters/PerPage'
710
+ parameters:
711
+ - $ref: '#/components/parameters/TenantId'
712
+ '/{tenant_id}/messages/{message_id}':
713
+ get:
714
+ tags:
715
+ - メッセージ
716
+ summary: メッセージ取得(単体)
717
+ description: メッセージ取得(単体)する
718
+ operationId: get-tenant_id-messages-message_id
719
+ responses:
720
+ '200':
721
+ description: OK
722
+ content:
723
+ application/json:
724
+ schema:
725
+ $ref: '#/components/schemas/Message'
726
+ parameters:
727
+ - $ref: '#/components/parameters/ApiVersion'
728
+ parameters:
729
+ - $ref: '#/components/parameters/TenantId'
730
+ - $ref: '#/components/parameters/MessageId'
731
+ '/{tenant_id}/messages/{message_id}/cancel':
732
+ post:
733
+ tags:
734
+ - メッセージ
735
+ summary: メッセージ送信キャンセル
736
+ description: |-
737
+ メッセージ送信キャンセルする
738
+ メッセージは送信予約日時の5分前までキャンセル可能
739
+ operationId: post-tenant_id-messages-message_id-cancel
740
+ parameters:
741
+ - $ref: '#/components/parameters/ApiVersion'
742
+ responses:
743
+ '200':
744
+ description: OK
745
+ content:
746
+ application/json:
747
+ schema:
748
+ $ref: '#/components/schemas/Message'
749
+ '400':
750
+ description: Bad Request
751
+ content:
752
+ application/json:
753
+ schema:
754
+ $ref: '#/components/schemas/Error'
755
+ examples:
756
+ example-1:
757
+ value:
758
+ object: error
759
+ code: can_not_cancel_message
760
+ message: メッセージのキャンセルができません、予約投稿のメッセージは開始5分前までキャンセル可能です。
761
+ errors: null
762
+ parameters:
763
+ - $ref: '#/components/parameters/TenantId'
764
+ - $ref: '#/components/parameters/MessageId'
765
+ /callback/messages/test/sent:
766
+ post:
767
+ summary: メッセージ送達結果通知
768
+ operationId: post-callback-messages-test-sent
769
+ responses:
770
+ '200':
771
+ description: OK
772
+ description: メッセージを送信した後、serviceに指定されているエンドポイントへ送達結果を通知する
773
+ security: []
774
+ parameters:
775
+ - $ref: '#/components/parameters/ApiVersion'
776
+ tags:
777
+ - メッセージ
778
+ requestBody:
779
+ content:
780
+ application/json:
781
+ schema:
782
+ $ref: '#/components/schemas/SentMessage'
783
+ description: ''