pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

data/docs/organization.md

@@ -0,0 +1,292 @@
+# Organization
+
+<a name="list-organizations"></a>
+## ListOrganizations: 加盟店組織の一覧を取得する
+
+```RUBY
+response = $client.send(Pokepay::Request::ListOrganizations.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          page: 1,                                              # ページ番号
+                          per_page: 50,                                         # 1ページ分の取引数
+                          name: "7",                                            # 組織名
+                          code: "69wB"                                          # 組織コード
+))
+```
+
+
+
+### Parameters
+**`private_money_id`** 
+  
+
+マネーIDです。
+このマネーに加盟している加盟組織がフィルターされます。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`page`** 
+  
+
+取得したいページ番号です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+1ページ分の取引数です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`name`** 
+  
+
+
+```json
+{
+  "type": "string"
+}
+```
+
+**`code`** 
+  
+
+
+```json
+{
+  "type": "string"
+}
+```
+
+
+
+成功したときは
+[PaginatedOrganizations](./responses.md#paginated-organizations)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|400|invalid_parameters|項目が無効です|Invalid parameters|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|private_money_not_found||Private money not found|
+
+
+
+---
+
+
+<a name="create-organization"></a>
+## CreateOrganization: 新規加盟店組織を追加する
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateOrganization.new(
+                          "ox-supermarket",                                     # code: 新規組織コード
+                          "oxスーパー",                                             # name: 新規組織名
+                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], # private_money_ids: 加盟店組織で有効にするマネーIDの配列
+                          "PR32MXZafz@3jff.com",                                # issuer_admin_user_email: 発行体担当者メールアドレス
+                          "pT8lgGERnF@dcWh.com",                                # member_admin_user_email: 新規組織担当者メールアドレス
+                          bank_name: "XYZ銀行",                                   # 銀行名
+                          bank_code: "1234",                                    # 銀行金融機関コード
+                          bank_branch_name: "ABC支店",                            # 銀行支店名
+                          bank_branch_code: "123",                              # 銀行支店コード
+                          bank_account_type: "saving",                          # 銀行口座種別 (普通=saving, 当座=current, その他=other)
+                          bank_account: "1234567",                              # 銀行口座番号
+                          bank_account_holder_name: "ﾌｸｻﾞﾜﾕｷﾁ",                 # 口座名義人名
+                          contact_name: "佐藤清"                                   # 担当者名
+))
+```
+
+
+
+### Parameters
+**`code`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 32
+}
+```
+
+**`name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 256
+}
+```
+
+**`private_money_ids`** 
+  
+
+
+```json
+{
+  "type": "array",
+  "minItems": 1,
+  "items": {
+    "type": "string",
+    "format": "uuid"
+  }
+}
+```
+
+**`issuer_admin_user_email`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "email"
+}
+```
+
+**`member_admin_user_email`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "email"
+}
+```
+
+**`bank_name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 64
+}
+```
+
+**`bank_code`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "pattern": "^$|^[0-9]{4}$"
+}
+```
+
+**`bank_branch_name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 64
+}
+```
+
+**`bank_branch_code`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "pattern": "^(|[0-9]{3})$"
+}
+```
+
+**`bank_account_type`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "enum": [
+    "saving",
+    "current",
+    "other"
+  ]
+}
+```
+
+**`bank_account`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 7,
+  "pattern": "[0-9]{0,7}"
+}
+```
+
+**`bank_account_holder_name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 30,
+  "pattern": "^[0-9A-Zｦｱ-ﾟ (-),-/\\\\｢-｣]$"
+}
+```
+
+**`contact_name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 256
+}
+```
+
+
+
+成功したときは
+[Organization](./responses.md#organization)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|NULL|NULL|NULL|
+|409|organization_conflict||The organization code is already used|
+|409|shop_name_conflict||The shop name is already used|
+|422|organization_private_money_not_found||Issuer organization does not have private-money|
+|422|unavailable_private_money||Given private money(s) is/are not available|
+|503|failed_to_send_email||Failed to send an E-mail.|
+
+
+
+---
+
+
+

data/docs/private_money.md

@@ -0,0 +1,213 @@
+# Private Money
+
+<a name="get-private-moneys"></a>
+## GetPrivateMoneys: マネー一覧を取得する
+マネーの一覧を取得します。
+パートナーキーの管理者が発行体組織に属している場合、自組織が加盟または発行しているマネーの一覧を返します。また、`organization_code`として決済加盟店の組織コードを指定した場合、発行マネーのうち、その決済加盟店組織が加盟しているマネーの一覧を返します。
+パートナーキーの管理者が決済加盟店組織に属している場合は、自組織が加盟しているマネーの一覧を返します。
+
+```RUBY
+response = $client.send(Pokepay::Request::GetPrivateMoneys.new(
+                          organization_code: "ox-supermarket",                  # 組織コード
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取得数
+))
+```
+
+
+
+### Parameters
+**`organization_code`** 
+  
+
+パートナーキーの管理者が発行体組織に属している場合、発行マネーのうち、この組織コードで指定した決済加盟店組織が加盟しているマネーの一覧を返します。決済加盟店組織の管理者は自組織以外を指定することはできません。
+
+```json
+{
+  "type": "string",
+  "maxLength": 32,
+  "pattern": "^[a-zA-Z0-9-]*$"
+}
+```
+
+**`page`** 
+  
+
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+
+
+成功したときは
+[PaginatedPrivateMoneys](./responses.md#paginated-private-moneys)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|organization_not_found||Organization not found|
+
+
+
+---
+
+
+<a name="get-private-money-organization-summaries"></a>
+## GetPrivateMoneyOrganizationSummaries: 決済加盟店の取引サマリを取得する
+
+```RUBY
+response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          from: "2021-11-30T18:21:25.000000Z",                  # 開始日時(toと同時に指定する必要有)
+                          to: "2020-10-18T01:48:22.000000Z",                    # 終了日時(fromと同時に指定する必要有)
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取引数
+))
+```
+
+`from`と`to`は同時に指定する必要があります。
+
+
+### Parameters
+**`private_money_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`from`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+**`to`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+**`page`** 
+  
+
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+
+
+成功したときは
+[PaginatedPrivateMoneyOrganizationSummaries](./responses.md#paginated-private-money-organization-summaries)
+を返します
+
+
+
+---
+
+
+<a name="get-private-money-summary"></a>
+## GetPrivateMoneySummary: 取引サマリを取得する
+
+```RUBY
+response = $client.send(Pokepay::Request::GetPrivateMoneySummary.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          from: "2020-12-07T17:39:18.000000Z",                  # 開始日時
+                          to: "2022-05-26T23:51:41.000000Z"                     # 終了日時
+))
+```
+
+
+
+### Parameters
+**`private_money_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`from`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+**`to`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+
+
+成功したときは
+[PrivateMoneySummary](./responses.md#private-money-summary)
+を返します
+
+
+
+---
+
+
+