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
@@ -0,0 +1,292 @@
1
+ # Organization
2
+
3
+ <a name="list-organizations"></a>
4
+ ## ListOrganizations: 加盟店組織の一覧を取得する
5
+
6
+ ```RUBY
7
+ response = $client.send(Pokepay::Request::ListOrganizations.new(
8
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
9
+ page: 1, # ページ番号
10
+ per_page: 50, # 1ページ分の取引数
11
+ name: "7", # 組織名
12
+ code: "69wB" # 組織コード
13
+ ))
14
+ ```
15
+
16
+
17
+
18
+ ### Parameters
19
+ **`private_money_id`**
20
+
21
+
22
+ マネーIDです。
23
+ このマネーに加盟している加盟組織がフィルターされます。
24
+
25
+ ```json
26
+ {
27
+ "type": "string",
28
+ "format": "uuid"
29
+ }
30
+ ```
31
+
32
+ **`page`**
33
+
34
+
35
+ 取得したいページ番号です。
36
+
37
+ ```json
38
+ {
39
+ "type": "integer",
40
+ "minimum": 1
41
+ }
42
+ ```
43
+
44
+ **`per_page`**
45
+
46
+
47
+ 1ページ分の取引数です。
48
+
49
+ ```json
50
+ {
51
+ "type": "integer",
52
+ "minimum": 1
53
+ }
54
+ ```
55
+
56
+ **`name`**
57
+
58
+
59
+
60
+ ```json
61
+ {
62
+ "type": "string"
63
+ }
64
+ ```
65
+
66
+ **`code`**
67
+
68
+
69
+
70
+ ```json
71
+ {
72
+ "type": "string"
73
+ }
74
+ ```
75
+
76
+
77
+
78
+ 成功したときは
79
+ [PaginatedOrganizations](./responses.md#paginated-organizations)
80
+ を返します
81
+
82
+ ### Error Responses
83
+ |status|type|ja|en|
84
+ |---|---|---|---|
85
+ |400|invalid_parameters|項目が無効です|Invalid parameters|
86
+ |403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
87
+ |422|private_money_not_found||Private money not found|
88
+
89
+
90
+
91
+ ---
92
+
93
+
94
+ <a name="create-organization"></a>
95
+ ## CreateOrganization: 新規加盟店組織を追加する
96
+
97
+ ```RUBY
98
+ response = $client.send(Pokepay::Request::CreateOrganization.new(
99
+ "ox-supermarket", # code: 新規組織コード
100
+ "oxスーパー", # name: 新規組織名
101
+ ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # private_money_ids: 加盟店組織で有効にするマネーIDの配列
102
+ "PR32MXZafz@3jff.com", # issuer_admin_user_email: 発行体担当者メールアドレス
103
+ "pT8lgGERnF@dcWh.com", # member_admin_user_email: 新規組織担当者メールアドレス
104
+ bank_name: "XYZ銀行", # 銀行名
105
+ bank_code: "1234", # 銀行金融機関コード
106
+ bank_branch_name: "ABC支店", # 銀行支店名
107
+ bank_branch_code: "123", # 銀行支店コード
108
+ bank_account_type: "saving", # 銀行口座種別 (普通=saving, 当座=current, その他=other)
109
+ bank_account: "1234567", # 銀行口座番号
110
+ bank_account_holder_name: "フクザワユキチ", # 口座名義人名
111
+ contact_name: "佐藤清" # 担当者名
112
+ ))
113
+ ```
114
+
115
+
116
+
117
+ ### Parameters
118
+ **`code`**
119
+
120
+
121
+
122
+ ```json
123
+ {
124
+ "type": "string",
125
+ "maxLength": 32
126
+ }
127
+ ```
128
+
129
+ **`name`**
130
+
131
+
132
+
133
+ ```json
134
+ {
135
+ "type": "string",
136
+ "maxLength": 256
137
+ }
138
+ ```
139
+
140
+ **`private_money_ids`**
141
+
142
+
143
+
144
+ ```json
145
+ {
146
+ "type": "array",
147
+ "minItems": 1,
148
+ "items": {
149
+ "type": "string",
150
+ "format": "uuid"
151
+ }
152
+ }
153
+ ```
154
+
155
+ **`issuer_admin_user_email`**
156
+
157
+
158
+
159
+ ```json
160
+ {
161
+ "type": "string",
162
+ "format": "email"
163
+ }
164
+ ```
165
+
166
+ **`member_admin_user_email`**
167
+
168
+
169
+
170
+ ```json
171
+ {
172
+ "type": "string",
173
+ "format": "email"
174
+ }
175
+ ```
176
+
177
+ **`bank_name`**
178
+
179
+
180
+
181
+ ```json
182
+ {
183
+ "type": "string",
184
+ "maxLength": 64
185
+ }
186
+ ```
187
+
188
+ **`bank_code`**
189
+
190
+
191
+
192
+ ```json
193
+ {
194
+ "type": "string",
195
+ "pattern": "^$|^[0-9]{4}$"
196
+ }
197
+ ```
198
+
199
+ **`bank_branch_name`**
200
+
201
+
202
+
203
+ ```json
204
+ {
205
+ "type": "string",
206
+ "maxLength": 64
207
+ }
208
+ ```
209
+
210
+ **`bank_branch_code`**
211
+
212
+
213
+
214
+ ```json
215
+ {
216
+ "type": "string",
217
+ "pattern": "^(|[0-9]{3})$"
218
+ }
219
+ ```
220
+
221
+ **`bank_account_type`**
222
+
223
+
224
+
225
+ ```json
226
+ {
227
+ "type": "string",
228
+ "enum": [
229
+ "saving",
230
+ "current",
231
+ "other"
232
+ ]
233
+ }
234
+ ```
235
+
236
+ **`bank_account`**
237
+
238
+
239
+
240
+ ```json
241
+ {
242
+ "type": "string",
243
+ "maxLength": 7,
244
+ "pattern": "[0-9]{0,7}"
245
+ }
246
+ ```
247
+
248
+ **`bank_account_holder_name`**
249
+
250
+
251
+
252
+ ```json
253
+ {
254
+ "type": "string",
255
+ "maxLength": 30,
256
+ "pattern": "^[0-9A-Zヲア-゚ (-),-/\\\\「-」]$"
257
+ }
258
+ ```
259
+
260
+ **`contact_name`**
261
+
262
+
263
+
264
+ ```json
265
+ {
266
+ "type": "string",
267
+ "maxLength": 256
268
+ }
269
+ ```
270
+
271
+
272
+
273
+ 成功したときは
274
+ [Organization](./responses.md#organization)
275
+ を返します
276
+
277
+ ### Error Responses
278
+ |status|type|ja|en|
279
+ |---|---|---|---|
280
+ |403|NULL|NULL|NULL|
281
+ |409|organization_conflict||The organization code is already used|
282
+ |409|shop_name_conflict||The shop name is already used|
283
+ |422|organization_private_money_not_found||Issuer organization does not have private-money|
284
+ |422|unavailable_private_money||Given private money(s) is/are not available|
285
+ |503|failed_to_send_email||Failed to send an E-mail.|
286
+
287
+
288
+
289
+ ---
290
+
291
+
292
+
@@ -0,0 +1,213 @@
1
+ # Private Money
2
+
3
+ <a name="get-private-moneys"></a>
4
+ ## GetPrivateMoneys: マネー一覧を取得する
5
+ マネーの一覧を取得します。
6
+ パートナーキーの管理者が発行体組織に属している場合、自組織が加盟または発行しているマネーの一覧を返します。また、`organization_code`として決済加盟店の組織コードを指定した場合、発行マネーのうち、その決済加盟店組織が加盟しているマネーの一覧を返します。
7
+ パートナーキーの管理者が決済加盟店組織に属している場合は、自組織が加盟しているマネーの一覧を返します。
8
+
9
+ ```RUBY
10
+ response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
11
+ organization_code: "ox-supermarket", # 組織コード
12
+ page: 1, # ページ番号
13
+ per_page: 50 # 1ページ分の取得数
14
+ ))
15
+ ```
16
+
17
+
18
+
19
+ ### Parameters
20
+ **`organization_code`**
21
+
22
+
23
+ パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
24
+
25
+ ```json
26
+ {
27
+ "type": "string",
28
+ "maxLength": 32,
29
+ "pattern": "^[a-zA-Z0-9-]*$"
30
+ }
31
+ ```
32
+
33
+ **`page`**
34
+
35
+
36
+
37
+ ```json
38
+ {
39
+ "type": "integer",
40
+ "minimum": 1
41
+ }
42
+ ```
43
+
44
+ **`per_page`**
45
+
46
+
47
+
48
+ ```json
49
+ {
50
+ "type": "integer",
51
+ "minimum": 1
52
+ }
53
+ ```
54
+
55
+
56
+
57
+ 成功したときは
58
+ [PaginatedPrivateMoneys](./responses.md#paginated-private-moneys)
59
+ を返します
60
+
61
+ ### Error Responses
62
+ |status|type|ja|en|
63
+ |---|---|---|---|
64
+ |403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
65
+ |422|organization_not_found||Organization not found|
66
+
67
+
68
+
69
+ ---
70
+
71
+
72
+ <a name="get-private-money-organization-summaries"></a>
73
+ ## GetPrivateMoneyOrganizationSummaries: 決済加盟店の取引サマリを取得する
74
+
75
+ ```RUBY
76
+ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
77
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
78
+ from: "2021-11-30T18:21:25.000000Z", # 開始日時(toと同時に指定する必要有)
79
+ to: "2020-10-18T01:48:22.000000Z", # 終了日時(fromと同時に指定する必要有)
80
+ page: 1, # ページ番号
81
+ per_page: 50 # 1ページ分の取引数
82
+ ))
83
+ ```
84
+
85
+ `from`と`to`は同時に指定する必要があります。
86
+
87
+
88
+ ### Parameters
89
+ **`private_money_id`**
90
+
91
+
92
+
93
+ ```json
94
+ {
95
+ "type": "string",
96
+ "format": "uuid"
97
+ }
98
+ ```
99
+
100
+ **`from`**
101
+
102
+
103
+
104
+ ```json
105
+ {
106
+ "type": "string",
107
+ "format": "date-time"
108
+ }
109
+ ```
110
+
111
+ **`to`**
112
+
113
+
114
+
115
+ ```json
116
+ {
117
+ "type": "string",
118
+ "format": "date-time"
119
+ }
120
+ ```
121
+
122
+ **`page`**
123
+
124
+
125
+
126
+ ```json
127
+ {
128
+ "type": "integer",
129
+ "minimum": 1
130
+ }
131
+ ```
132
+
133
+ **`per_page`**
134
+
135
+
136
+
137
+ ```json
138
+ {
139
+ "type": "integer",
140
+ "minimum": 1
141
+ }
142
+ ```
143
+
144
+
145
+
146
+ 成功したときは
147
+ [PaginatedPrivateMoneyOrganizationSummaries](./responses.md#paginated-private-money-organization-summaries)
148
+ を返します
149
+
150
+
151
+
152
+ ---
153
+
154
+
155
+ <a name="get-private-money-summary"></a>
156
+ ## GetPrivateMoneySummary: 取引サマリを取得する
157
+
158
+ ```RUBY
159
+ response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
160
+ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # private_money_id: マネーID
161
+ from: "2020-12-07T17:39:18.000000Z", # 開始日時
162
+ to: "2022-05-26T23:51:41.000000Z" # 終了日時
163
+ ))
164
+ ```
165
+
166
+
167
+
168
+ ### Parameters
169
+ **`private_money_id`**
170
+
171
+
172
+
173
+ ```json
174
+ {
175
+ "type": "string",
176
+ "format": "uuid"
177
+ }
178
+ ```
179
+
180
+ **`from`**
181
+
182
+
183
+
184
+ ```json
185
+ {
186
+ "type": "string",
187
+ "format": "date-time"
188
+ }
189
+ ```
190
+
191
+ **`to`**
192
+
193
+
194
+
195
+ ```json
196
+ {
197
+ "type": "string",
198
+ "format": "date-time"
199
+ }
200
+ ```
201
+
202
+
203
+
204
+ 成功したときは
205
+ [PrivateMoneySummary](./responses.md#private-money-summary)
206
+ を返します
207
+
208
+
209
+
210
+ ---
211
+
212
+
213
+