pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

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 (59) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/release-pr.yml +18 -0
  3. data/Gemfile.lock +1 -1
  4. data/docs/README.md +269 -0
  5. data/docs/account.md +159 -0
  6. data/docs/bank_pay.md +235 -0
  7. data/docs/bill.md +365 -0
  8. data/docs/bulk.md +121 -0
  9. data/docs/campaign.md +1749 -0
  10. data/docs/cashtray.md +318 -0
  11. data/docs/check.md +883 -0
  12. data/docs/coupon.md +724 -0
  13. data/docs/customer.md +1042 -0
  14. data/docs/error-response.csv +839 -0
  15. data/docs/event.md +308 -0
  16. data/docs/index.md +1279 -305
  17. data/docs/organization.md +292 -0
  18. data/docs/private_money.md +213 -0
  19. data/docs/responses.md +711 -0
  20. data/docs/shop.md +678 -0
  21. data/docs/transaction.md +2021 -0
  22. data/docs/transfer.md +686 -0
  23. data/docs/user.md +3 -0
  24. data/docs/user_device.md +134 -0
  25. data/docs/webhook.md +231 -0
  26. data/lib/pokepay_partner_ruby_sdk/request/activate_user_device.rb +15 -0
  27. data/lib/pokepay_partner_ruby_sdk/request/create_bank.rb +17 -0
  28. data/lib/pokepay_partner_ruby_sdk/request/create_bank_topup_transaction.rb +18 -0
  29. data/lib/pokepay_partner_ruby_sdk/request/create_coupon.rb +19 -0
  30. data/lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb +2 -2
  31. data/lib/pokepay_partner_ruby_sdk/request/create_transaction_with_cashtray.rb +16 -0
  32. data/lib/pokepay_partner_ruby_sdk/request/create_user_device.rb +15 -0
  33. data/lib/pokepay_partner_ruby_sdk/request/delete_webhook.rb +15 -0
  34. data/lib/pokepay_partner_ruby_sdk/request/get_check.rb +15 -0
  35. data/lib/pokepay_partner_ruby_sdk/request/get_coupon.rb +1 -1
  36. data/lib/pokepay_partner_ruby_sdk/request/get_external_transaction_by_request_id.rb +15 -0
  37. data/lib/pokepay_partner_ruby_sdk/request/get_user_device.rb +15 -0
  38. data/lib/pokepay_partner_ruby_sdk/request/list_banks.rb +15 -0
  39. data/lib/pokepay_partner_ruby_sdk/request/list_checks.rb +15 -0
  40. data/lib/pokepay_partner_ruby_sdk/request/list_organizations.rb +15 -0
  41. data/lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb +2 -2
  42. data/lib/pokepay_partner_ruby_sdk/request/update_check.rb +15 -0
  43. data/lib/pokepay_partner_ruby_sdk/request/update_coupon.rb +15 -0
  44. data/lib/pokepay_partner_ruby_sdk/response/bank.rb +28 -0
  45. data/lib/pokepay_partner_ruby_sdk/response/bank_registering_info.rb +13 -0
  46. data/lib/pokepay_partner_ruby_sdk/response/banks.rb +13 -0
  47. data/lib/pokepay_partner_ruby_sdk/response/campaign.rb +6 -0
  48. data/lib/pokepay_partner_ruby_sdk/response/check.rb +2 -0
  49. data/lib/pokepay_partner_ruby_sdk/response/external_transaction_detail.rb +34 -0
  50. data/lib/pokepay_partner_ruby_sdk/response/organization_summary.rb +4 -0
  51. data/lib/pokepay_partner_ruby_sdk/response/paginated_checks.rb +16 -0
  52. data/lib/pokepay_partner_ruby_sdk/response/paginated_organizations.rb +16 -0
  53. data/lib/pokepay_partner_ruby_sdk/response/private_money_summary.rb +4 -0
  54. data/lib/pokepay_partner_ruby_sdk/response/product.rb +2 -0
  55. data/lib/pokepay_partner_ruby_sdk/response/user_device.rb +18 -0
  56. data/lib/pokepay_partner_ruby_sdk/version.rb +1 -1
  57. data/lib/pokepay_partner_ruby_sdk.rb +26 -4
  58. data/partner.yaml +1578 -216
  59. metadata +46 -2
data/docs/coupon.md ADDED
@@ -0,0 +1,724 @@
1
+ # Coupon
2
+ Couponは支払い時に指定し、支払い処理の前にCouponに指定の方法で値引き処理を行います。
3
+ Couponは特定店舗で利用できるものや利用可能期間、配信条件などを設定できます。
4
+
5
+
6
+ <a name="list-coupons"></a>
7
+ ## ListCoupons: クーポン一覧の取得
8
+ 指定したマネーのクーポン一覧を取得します
9
+
10
+ ```RUBY
11
+ response = $client.send(Pokepay::Request::ListCoupons.new(
12
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: 対象クーポンのマネーID
13
+ coupon_id: "wQQegAi", # クーポンID
14
+ coupon_name: "W5", # クーポン名
15
+ issued_shop_name: "Gh", # 発行店舗名
16
+ available_shop_name: "EedI", # 利用可能店舗名
17
+ available_from: "2022-06-23T05:43:23.000000Z", # 利用可能期間 (開始日時)
18
+ available_to: "2023-10-18T23:09:00.000000Z", # 利用可能期間 (終了日時)
19
+ page: 1, # ページ番号
20
+ per_page: 50 # 1ページ分の取得数
21
+ ))
22
+ ```
23
+
24
+
25
+
26
+ ### Parameters
27
+ **`private_money_id`**
28
+
29
+
30
+ 対象クーポンのマネーIDです(必須項目)。
31
+ 存在しないマネーIDを指定した場合はprivate_money_not_foundエラー(422)が返ります。
32
+
33
+
34
+ ```json
35
+ {
36
+ "type": "string",
37
+ "format": "uuid"
38
+ }
39
+ ```
40
+
41
+ **`coupon_id`**
42
+
43
+
44
+ 指定されたクーポンIDで結果をフィルターします。
45
+ 部分一致(前方一致)します。
46
+
47
+
48
+ ```json
49
+ {
50
+ "type": "string"
51
+ }
52
+ ```
53
+
54
+ **`coupon_name`**
55
+
56
+
57
+ 指定されたクーポン名で結果をフィルターします。
58
+
59
+
60
+ ```json
61
+ {
62
+ "type": "string"
63
+ }
64
+ ```
65
+
66
+ **`issued_shop_name`**
67
+
68
+
69
+ 指定された発行店舗で結果をフィルターします。
70
+
71
+
72
+ ```json
73
+ {
74
+ "type": "string"
75
+ }
76
+ ```
77
+
78
+ **`available_shop_name`**
79
+
80
+
81
+ 指定された利用可能店舗で結果をフィルターします。
82
+
83
+
84
+ ```json
85
+ {
86
+ "type": "string"
87
+ }
88
+ ```
89
+
90
+ **`available_from`**
91
+
92
+
93
+ 利用可能期間でフィルターします。フィルターの開始日時をISO8601形式で指定します。
94
+
95
+
96
+ ```json
97
+ {
98
+ "type": "string",
99
+ "format": "date-time"
100
+ }
101
+ ```
102
+
103
+ **`available_to`**
104
+
105
+
106
+ 利用可能期間でフィルターします。フィルターの終了日時をISO8601形式で指定します。
107
+
108
+
109
+ ```json
110
+ {
111
+ "type": "string",
112
+ "format": "date-time"
113
+ }
114
+ ```
115
+
116
+ **`page`**
117
+
118
+
119
+ 取得したいページ番号です。
120
+
121
+ ```json
122
+ {
123
+ "type": "integer",
124
+ "minimum": 1
125
+ }
126
+ ```
127
+
128
+ **`per_page`**
129
+
130
+
131
+ 1ページ分の取得数です。デフォルトでは 50 になっています。
132
+
133
+ ```json
134
+ {
135
+ "type": "integer",
136
+ "minimum": 1
137
+ }
138
+ ```
139
+
140
+
141
+
142
+ 成功したときは
143
+ [PaginatedCoupons](./responses.md#paginated-coupons)
144
+ を返します
145
+
146
+ ### Error Responses
147
+ |status|type|ja|en|
148
+ |---|---|---|---|
149
+ |403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
150
+ |422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
151
+ |422|private_money_not_found||Private money not found|
152
+
153
+
154
+
155
+ ---
156
+
157
+
158
+ <a name="create-coupon"></a>
159
+ ## CreateCoupon: クーポンの登録
160
+ 新しいクーポンを登録します
161
+
162
+ ```RUBY
163
+ response = $client.send(Pokepay::Request::CreateCoupon.new(
164
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
165
+ "oAN4R6PBgm1b",
166
+ "2022-10-24T17:40:16.000000Z",
167
+ "2024-02-23T20:37:41.000000Z",
168
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # issued_shop_id: 発行元の店舗ID
169
+ description: "bkQVRY8MuhwDykulFo5mDyJw8V3XaTOkFDFDXkJRYuzmNrD0IPFMYcPpoEqcZqYNWKYupHW3vkZPbupwOmpLyfcnvR24ekndSEuijqLz34cJjz9WzSXV2waIpnDEjnPuGDOLqsy",
170
+ discount_amount: 5664,
171
+ discount_percentage: 831.0,
172
+ discount_upper_limit: 5300,
173
+ display_starts_at: "2022-06-11T06:33:09.000000Z", # クーポンの掲載期間(開始日時)
174
+ display_ends_at: "2024-03-10T06:14:25.000000Z", # クーポンの掲載期間(終了日時)
175
+ is_disabled: true, # 無効化フラグ
176
+ is_hidden: false, # クーポン一覧に掲載されるかどうか
177
+ is_public: false, # アプリ配信なしで受け取れるかどうか
178
+ code: "6hyzJ", # クーポン受け取りコード
179
+ usage_limit: 1003, # ユーザごとの利用可能回数(NULLの場合は無制限)
180
+ min_amount: 4620, # クーポン適用可能な最小取引額
181
+ is_shop_specified: false, # 特定店舗限定のクーポンかどうか
182
+ available_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 利用可能店舗リスト
183
+ storage_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ストレージID
184
+ ))
185
+ ```
186
+
187
+ `is_shop_specified`と`available_shop_ids`は同時に指定する必要があります。
188
+
189
+
190
+ ### Parameters
191
+ **`private_money_id`**
192
+
193
+
194
+
195
+ ```json
196
+ {
197
+ "type": "string",
198
+ "format": "uuid"
199
+ }
200
+ ```
201
+
202
+ **`name`**
203
+
204
+
205
+
206
+ ```json
207
+ {
208
+ "type": "string",
209
+ "maxLength": 128
210
+ }
211
+ ```
212
+
213
+ **`description`**
214
+
215
+
216
+
217
+ ```json
218
+ {
219
+ "type": "string",
220
+ "maxLength": 256
221
+ }
222
+ ```
223
+
224
+ **`discount_amount`**
225
+
226
+
227
+
228
+ ```json
229
+ {
230
+ "type": "integer",
231
+ "minimum": 0
232
+ }
233
+ ```
234
+
235
+ **`discount_percentage`**
236
+
237
+
238
+
239
+ ```json
240
+ {
241
+ "type": "number",
242
+ "minimum": 0
243
+ }
244
+ ```
245
+
246
+ **`discount_upper_limit`**
247
+
248
+
249
+
250
+ ```json
251
+ {
252
+ "type": "integer",
253
+ "minimum": 0
254
+ }
255
+ ```
256
+
257
+ **`starts_at`**
258
+
259
+
260
+
261
+ ```json
262
+ {
263
+ "type": "string",
264
+ "format": "date-time"
265
+ }
266
+ ```
267
+
268
+ **`ends_at`**
269
+
270
+
271
+
272
+ ```json
273
+ {
274
+ "type": "string",
275
+ "format": "date-time"
276
+ }
277
+ ```
278
+
279
+ **`display_starts_at`**
280
+
281
+
282
+
283
+ ```json
284
+ {
285
+ "type": "string",
286
+ "format": "date-time"
287
+ }
288
+ ```
289
+
290
+ **`display_ends_at`**
291
+
292
+
293
+
294
+ ```json
295
+ {
296
+ "type": "string",
297
+ "format": "date-time"
298
+ }
299
+ ```
300
+
301
+ **`is_disabled`**
302
+
303
+
304
+
305
+ ```json
306
+ {
307
+ "type": "boolean"
308
+ }
309
+ ```
310
+
311
+ **`is_hidden`**
312
+
313
+
314
+ アプリに表示されるクーポン一覧に掲載されるかどうか。
315
+ 主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
316
+
317
+
318
+ ```json
319
+ {
320
+ "type": "boolean"
321
+ }
322
+ ```
323
+
324
+ **`is_public`**
325
+
326
+
327
+
328
+ ```json
329
+ {
330
+ "type": "boolean"
331
+ }
332
+ ```
333
+
334
+ **`code`**
335
+
336
+
337
+
338
+ ```json
339
+ {
340
+ "type": "string"
341
+ }
342
+ ```
343
+
344
+ **`usage_limit`**
345
+
346
+
347
+
348
+ ```json
349
+ {
350
+ "type": "integer"
351
+ }
352
+ ```
353
+
354
+ **`min_amount`**
355
+
356
+
357
+
358
+ ```json
359
+ {
360
+ "type": "integer"
361
+ }
362
+ ```
363
+
364
+ **`issued_shop_id`**
365
+
366
+
367
+
368
+ ```json
369
+ {
370
+ "type": "string",
371
+ "format": "uuid"
372
+ }
373
+ ```
374
+
375
+ **`is_shop_specified`**
376
+
377
+
378
+
379
+ ```json
380
+ {
381
+ "type": "boolean"
382
+ }
383
+ ```
384
+
385
+ **`available_shop_ids`**
386
+
387
+
388
+
389
+ ```json
390
+ {
391
+ "type": "array",
392
+ "items": {
393
+ "type": "string",
394
+ "format": "uuid"
395
+ }
396
+ }
397
+ ```
398
+
399
+ **`storage_id`**
400
+
401
+
402
+ Storage APIでアップロードしたクーポン画像のStorage IDを指定します
403
+
404
+ ```json
405
+ {
406
+ "type": "string",
407
+ "format": "uuid"
408
+ }
409
+ ```
410
+
411
+
412
+
413
+ 成功したときは
414
+ [CouponDetail](./responses.md#coupon-detail)
415
+ を返します
416
+
417
+ ### Error Responses
418
+ |status|type|ja|en|
419
+ |---|---|---|---|
420
+ |400|invalid_parameters|項目が無効です|Invalid parameters|
421
+ |403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
422
+ |404|partner_storage_not_found|指定したIDのデータは保存されていません|Not found by storage_id|
423
+ |422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
424
+ |422|private_money_not_found||Private money not found|
425
+ |422|coupon_image_storage_conflict|クーポン画像のストレージIDは既に存在します|The coupon image storage_id is already exists|
426
+
427
+
428
+
429
+ ---
430
+
431
+
432
+ <a name="get-coupon"></a>
433
+ ## GetCoupon: クーポンの取得
434
+ 指定したIDを持つクーポンを取得します
435
+
436
+ ```RUBY
437
+ response = $client.send(Pokepay::Request::GetCoupon.new(
438
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # coupon_id: クーポンID
439
+ ))
440
+ ```
441
+
442
+
443
+
444
+ ### Parameters
445
+ **`coupon_id`**
446
+
447
+
448
+ 取得するクーポンのIDです。
449
+ UUIDv4フォーマットである必要があり、フォーマットが異なる場合は InvalidParametersエラー(400)が返ります。
450
+ 指定したIDのクーポンが存在しない場合はCouponNotFoundエラー(422)が返ります。
451
+
452
+ ```json
453
+ {
454
+ "type": "string",
455
+ "format": "uuid"
456
+ }
457
+ ```
458
+
459
+
460
+
461
+ 成功したときは
462
+ [CouponDetail](./responses.md#coupon-detail)
463
+ を返します
464
+
465
+
466
+
467
+ ---
468
+
469
+
470
+ <a name="update-coupon"></a>
471
+ ## UpdateCoupon: クーポンの更新
472
+ 指定したクーポンを更新します
473
+
474
+ ```RUBY
475
+ response = $client.send(Pokepay::Request::UpdateCoupon.new(
476
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # coupon_id: クーポンID
477
+ name: "v4Vr2ADhNnBQ2AhJrtrRhEmEhncAz9T8Jn6tKv842hmKtJWGe0W2JoBVxOBG6QSEaMM6DcJjfAtdrmKAg3KBKDu0vlbYdVC6n9nVL",
478
+ description: "o43cE33CQPF6kxIlI0uguDnziraNYM7VX5YLnlD8HOOCDlP4GZ7jbmXMO5zVMwfk3fyCehTHNb57OPgysrQCIrNbKg5EGtS1CRG8HTOfVnvp3qGXZFBsOSpPHbliv7UIdhUMzObVJ",
479
+ discount_amount: 5374,
480
+ discount_percentage: 9031.0,
481
+ discount_upper_limit: 6197,
482
+ starts_at: "2021-02-18T11:09:22.000000Z",
483
+ ends_at: "2022-09-29T15:41:10.000000Z",
484
+ display_starts_at: "2022-01-29T04:18:14.000000Z", # クーポンの掲載期間(開始日時)
485
+ display_ends_at: "2022-07-12T21:07:00.000000Z", # クーポンの掲載期間(終了日時)
486
+ is_disabled: true, # 無効化フラグ
487
+ is_hidden: false, # クーポン一覧に掲載されるかどうか
488
+ is_public: false, # アプリ配信なしで受け取れるかどうか
489
+ code: "H5", # クーポン受け取りコード
490
+ usage_limit: 7026, # ユーザごとの利用可能回数(NULLの場合は無制限)
491
+ min_amount: 7775, # クーポン適用可能な最小取引額
492
+ is_shop_specified: false, # 特定店舗限定のクーポンかどうか
493
+ available_shop_ids: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # 利用可能店舗リスト
494
+ storage_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # ストレージID
495
+ ))
496
+ ```
497
+
498
+
499
+ `discount_amount`と`discount_percentage`の少なくとも一方は指定する必要があります。
500
+
501
+
502
+
503
+ ### Parameters
504
+ **`coupon_id`**
505
+
506
+
507
+
508
+ ```json
509
+ {
510
+ "type": "string",
511
+ "format": "uuid"
512
+ }
513
+ ```
514
+
515
+ **`name`**
516
+
517
+
518
+
519
+ ```json
520
+ {
521
+ "type": "string",
522
+ "maxLength": 128
523
+ }
524
+ ```
525
+
526
+ **`description`**
527
+
528
+
529
+
530
+ ```json
531
+ {
532
+ "type": "string",
533
+ "maxLength": 256
534
+ }
535
+ ```
536
+
537
+ **`discount_amount`**
538
+
539
+
540
+
541
+ ```json
542
+ {
543
+ "type": "integer",
544
+ "minimum": 0
545
+ }
546
+ ```
547
+
548
+ **`discount_percentage`**
549
+
550
+
551
+
552
+ ```json
553
+ {
554
+ "type": "number",
555
+ "minimum": 0
556
+ }
557
+ ```
558
+
559
+ **`discount_upper_limit`**
560
+
561
+
562
+
563
+ ```json
564
+ {
565
+ "type": "integer",
566
+ "minimum": 0
567
+ }
568
+ ```
569
+
570
+ **`starts_at`**
571
+
572
+
573
+
574
+ ```json
575
+ {
576
+ "type": "string",
577
+ "format": "date-time"
578
+ }
579
+ ```
580
+
581
+ **`ends_at`**
582
+
583
+
584
+
585
+ ```json
586
+ {
587
+ "type": "string",
588
+ "format": "date-time"
589
+ }
590
+ ```
591
+
592
+ **`display_starts_at`**
593
+
594
+
595
+
596
+ ```json
597
+ {
598
+ "type": "string",
599
+ "format": "date-time"
600
+ }
601
+ ```
602
+
603
+ **`display_ends_at`**
604
+
605
+
606
+
607
+ ```json
608
+ {
609
+ "type": "string",
610
+ "format": "date-time"
611
+ }
612
+ ```
613
+
614
+ **`is_disabled`**
615
+
616
+
617
+
618
+ ```json
619
+ {
620
+ "type": "boolean"
621
+ }
622
+ ```
623
+
624
+ **`is_hidden`**
625
+
626
+
627
+ アプリに表示されるクーポン一覧に掲載されるかどうか。
628
+ 主に一時的に掲載から外したいときに用いられる。そのためis_publicの設定よりも優先される。
629
+
630
+
631
+ ```json
632
+ {
633
+ "type": "boolean"
634
+ }
635
+ ```
636
+
637
+ **`is_public`**
638
+
639
+
640
+
641
+ ```json
642
+ {
643
+ "type": "boolean"
644
+ }
645
+ ```
646
+
647
+ **`code`**
648
+
649
+
650
+
651
+ ```json
652
+ {
653
+ "type": "string"
654
+ }
655
+ ```
656
+
657
+ **`usage_limit`**
658
+
659
+
660
+
661
+ ```json
662
+ {
663
+ "type": "integer"
664
+ }
665
+ ```
666
+
667
+ **`min_amount`**
668
+
669
+
670
+
671
+ ```json
672
+ {
673
+ "type": "integer"
674
+ }
675
+ ```
676
+
677
+ **`is_shop_specified`**
678
+
679
+
680
+
681
+ ```json
682
+ {
683
+ "type": "boolean"
684
+ }
685
+ ```
686
+
687
+ **`available_shop_ids`**
688
+
689
+
690
+
691
+ ```json
692
+ {
693
+ "type": "array",
694
+ "items": {
695
+ "type": "string",
696
+ "format": "uuid"
697
+ }
698
+ }
699
+ ```
700
+
701
+ **`storage_id`**
702
+
703
+
704
+ Storage APIでアップロードしたクーポン画像のStorage IDを指定します
705
+
706
+ ```json
707
+ {
708
+ "type": "string",
709
+ "format": "uuid"
710
+ }
711
+ ```
712
+
713
+
714
+
715
+ 成功したときは
716
+ [CouponDetail](./responses.md#coupon-detail)
717
+ を返します
718
+
719
+
720
+
721
+ ---
722
+
723
+
724
+