fidor_schema 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dc5099e6308916a078cd74e1e7a8912bc23be31
-  data.tar.gz: ccb1d0e215ddb06ff92f4f67636439b25a2f4db6
+  metadata.gz: cacd9b90d4afd09a59a09adfde1faf7df2947717
+  data.tar.gz: d777b912086d49bbc59711477aebafb75fd40546
 SHA512:
-  metadata.gz: 9fa70a26d0950850772a127b3cbdc9c8067c269007afe09eba86d5658493984d8453dc8f92fb719260233cba04d6c07bba2ace8a16bd83ef0801989a9b22af1f
-  data.tar.gz: 30cbb0cd681e1c984d6ed123872070147786df4a86720d3055175f10aa32dcfd57521e3b73b60c10c939835780a832b61f5a8cefe2379ad074faa02212da64ff
+  metadata.gz: 146f08392166a782420e9d34e9e22fc7bf7a050a948672966cdee5387cce6e42b88a23f6bba62ed4dc1798d4d107efc83d1ab8e4ded2ac1666fd93ee6b4663ae
+  data.tar.gz: 28f3fa2181234fd18d474c56f2df77be7f431127783350b8aaa5101ba16c400a5be7e25e2538cf4079facfb66237e3e2ac38c8200564beb2bd647c8dc039f0a7

data/.gitignore

@@ -6,3 +6,4 @@ Gemfile.lock
 .ruby-gemset
 *.swp
 .idea
+.DS_Store

data/.travis.yml

@@ -12,3 +12,5 @@ rvm:
 cache: bundler
 
 script: bundle exec rspec
+
+sudo: false

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 A more detailed view of the changes can be found in the [commit messages](https://github.com/fidor/fidor_schema/commits/)
 
+## v0.9.0 (2015-08-17)
+
+* New transaction types (`capital_gains_tax`, `solidarity_tax`).
+* Added `preauths` schema.
+* Added `short_term_loan` schema.
+* Enabled customer creation to the `customer` schema.
+* Various cleanups / small tweaks.
+
 ##2015-06
 
 * add transfer_approval resource

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/fidor/fidor_schema.svg?branch=master)](https://travis-ci.org/fidor/fidor_schema)
+
 # Fidor API Schema - BETA
 
 The Fidor API is described with [JSON Schema](http://json-schema.org), which serves
@@ -7,7 +9,7 @@ This gem(besides the schema) provides a single utility method: the path to the
 json files.
 
     gem install fidor_schema
-    
+
     require 'fidor_schema'
     Fidor::Schema.path
 

data/lib/fidor_schema_version.rb

@@ -1,5 +1,5 @@
 module Fidor
   class Schema
-    VERSION='0.8.0'
+    VERSION = '0.10.0'
   end
-end
+end

data/schema/v1.0/base_types/base_types.json

@@ -8,8 +8,10 @@
       "type"        : "string"
     },
     "account_id" : {
-      "description" : "Fidor account the transaction belongs to.",
-      "type"        : "string"
+      "description" : "Fidor account the transaction belongs to",
+      "type"        : "string",
+      "maxLength"   : 8,
+      "pattern"     : "^[0-9]{8}$"
     },
     "user_id" : {
       "description" : "Identifies the user who created this object",
@@ -21,41 +23,6 @@
       "readOnly"    : true,
       "type"        : "string"
     },
-    "transaction_type" : {
-      "description" : "Type of the transaction",
-      "enum"        : [
-        "bonus",
-        "credit_interest",
-        "creditcard_annual_fee",
-        "creditcard_atm_fee",
-        "creditcard_foreign_exchange_fee",
-        "creditcard_notification_fee",
-        "creditcard_order_cancellation",
-        "creditcard_order_fee",
-        "creditcard_order_withdrawal_fee",
-        "creditcard_payin",
-        "creditcard_payout",
-        "creditcard_preauth",
-        "creditcard_release",
-        "debit_interest",
-        "emoney_payin",
-        "fee",
-        "fidor_payin",
-        "fidor_payout",
-        "gmt_fee",
-        "gmt_refund",
-        "gmt_payout",
-        "payout",
-        "prepaid_mobile_topup",
-        "sepa_authorization",
-        "sepa_b2b_direct_debit",
-        "sepa_core_direct_debit",
-        "sepa_payin",
-        "unknown"
-      ],
-      "type" : "string",
-      "maxLength"   : 255
-    },
     "phone" : {
       "description" : "A phone or fax number, formatted with country code: +49 123 1233213",
       "type"        : "string",
@@ -132,6 +99,55 @@
       "description"      : "A fee amount in account currency, in minor units, e.g. 1EUR is represented as 100.",
       "type"             : "integer",
       "minimum"          : 0
+    },
+    "transaction_type": {
+      "description" : "Type of the transaction",
+      "enum"        : [
+        "bonus",
+        "credit_interest",
+        "creditcard_annual_fee",
+        "creditcard_atm_fee",
+        "creditcard_foreign_exchange_fee",
+        "creditcard_notification_fee",
+        "creditcard_order_cancellation",
+        "creditcard_order_fee",
+        "creditcard_order_withdrawal_fee",
+        "creditcard_payin",
+        "creditcard_payout",
+        "creditcard_preauth",
+        "creditcard_release",
+        "debit_interest",
+        "emoney_payin",
+        "fee",
+        "fidor_payin",
+        "fidor_payout",
+        "gmt_fee",
+        "gmt_refund",
+        "gmt_payout",
+        "payout",
+        "prepaid_mobile_topup",
+        "sepa_authorization",
+        "sepa_b2b_direct_debit",
+        "sepa_core_direct_debit",
+        "sepa_payin",
+        "unknown"
+      ],
+      "type" : "string",
+      "maxLength"   : 255
+    },
+    "preauth_type": {
+      "description" : "Type of the preauthorization",
+      "enum"        : [
+        "creditcard_preauth",
+        "internal_transfer_preauth",
+        "capital_bond_preauth",
+        "currency_order_preauth",
+        "gmt_preauth",
+        "ripple_preauth",
+        "unknown"
+      ],
+      "type" : "string",
+      "maxLength"   : 255
     }
   }
 }

data/schema/v1.0/blocked_amount.json

@@ -0,0 +1,10 @@
+{
+  "type"        : "object",
+  "title"       : "Blocked Amount",
+  "name"        : "blocked_amount",
+  "description" : "",
+  "properties"  : {
+
+  },
+  "links" : []
+}

data/schema/v1.0/card/pin.json

@@ -0,0 +1,22 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "Card PIN Code",
+  "name"        : "pin",
+  "rel"         : "pin",
+  "description" : "Card PIN code",
+  "parent"      : "card",
+  "properties": {
+    "id": {
+      "$ref"        : "../base_types/base_types.json#definitions/id"
+    },
+    "account_id" : {
+      "$ref"        : "../base_types/base_types.json#definitions/account_id"
+    },
+    "pin" : {
+      "description" : "Personal identification number of the card",
+      "type"        : "string",
+      "pattern"     : "^[0-9]{4}$"
+    }
+  }
+}

data/schema/v1.0/card.json

@@ -0,0 +1,236 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "Card",
+  "name"        : "card",
+  "description" : "Cards endpoint",
+  "required"    : ["type", "design", "currency", "pin"],
+  "properties"  : {
+    "id" : {
+      "$ref"        : "./base_types/base_types.json#definitions/id"
+    },
+    "account_id" : {
+      "$ref"        : "./base_types/base_types.json#definitions/account_id",
+      "readOnly"    : true
+    },
+    "inscription" : {
+      "description" : "Card holder",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "type" : {
+      "description" : "Card type",
+      "type"        : "string",
+      "enum"        : [
+        "fidor_digital_prepaid_mastercard_virtual",
+        "fidor_smart_prepaid_mastercard_cowboy",
+        "fidor_smart_prepaid_mastercard_ambassador",
+        "fidor_smart_prepaid_mastercard_girls",
+        "fidor_smart_prepaid_mastercard_pimp",
+        "fidor_smart_prepaid_mastercard_community",
+        "fidor_smart_prepaid_mastercard_classic_black",
+        "fidor_smart_prepaid_mastercard_classic_green",
+        "fidor_digital_prepaid_mastercard_virtuell",
+        "fidor_smart_prepaid_mastercard_classic_green2",
+        "fidor_smart_prepaid_mastercard_classic_black2",
+        "fidor_smart_prepaid_mastercard_classic_green_bis",
+        "fidor_smart_prepaid_mastercard_classic_black_bis",
+        "fidor_corporatecard_classic",
+        "fidor_smart_prepaid_mastercard_classic_green_ter",
+        "fidor_smart_prepaid_mastercard_classic_black_ter",
+        "fidor_travian_prepaid_mastercard",
+        "fidor_smartcard",
+        "fidor_debit_master_card"
+      ]
+    },
+    "design" : {
+      "description" : "Card design",
+      "type"        : "string"
+    },
+    "currency" : {
+      "$ref"        : "./base_types/base_types.json#definitions/currency"
+    },
+    "physical" : {
+      "description" : "Indicates if the card is a physical one",
+      "type"        : "boolean",
+      "readOnly"    : true
+    },
+    "valid_until" : {
+      "description" : "Card expiration date",
+      "format"      : "date-time",
+      "readOnly"    : true
+    },
+    "balance" : {
+      "description" : "Balance of the related account in minor units, e.g. 1EUR is represented as 100. Must be greater than 0 e.g. at least one cent in EUR",
+      "$ref" : "./base_types/base_types.json#definitions/amount",
+      "readOnly"    : true
+    },
+    "atm_limit" : {
+      "description" : "ATM limit in minor units, e.g. 1EUR is represented as 100. Must be greater than 0 e.g. at least one cent in EUR",
+      "$ref" : "./base_types/base_types.json#definitions/amount"
+    },
+    "transaction_single_limit" : {
+      "description" : "Transaction single limit in minor units, e.g. 1EUR is represented as 100. Must be greater than 0 e.g. at least one cent in EUR",
+      "$ref" : "./base_types/base_types.json#definitions/amount"
+    },
+    "transaction_volume_limit" : {
+      "description" : "Transaction volume limit in minor units, e.g. 1EUR is represented as 100. Must be greater than 0 e.g. at least one cent in EUR",
+      "$ref" : "./base_types/base_types.json#definitions/amount"
+    },
+    "email_notification" : {
+      "description" : "Email notification",
+      "type"        : "boolean",
+      "default"     : true
+    },
+    "sms_notification" : {
+      "description" : "SMS notification",
+      "type"        : "boolean",
+      "default"     : false
+    },
+    "payed" : {
+      "description" : "Card payed boolean",
+      "type" : "boolean",
+      "readOnly"    : true
+    },
+    "state" : {
+      "description" : "State of the card",
+      "type"        : "string",
+      "enum" : [
+        "created",
+        "mobile_tan_sent",
+        "card_registration_requirments_check",
+        "card_registration_pending",
+        "card_registration_in_progress",
+        "card_registration_canceled",
+        "card_registration_completed",
+        "active",
+        "revoked",
+        "canceled",
+        "disabled",
+        "lost",
+        "expired",
+        "annual_fee_pending_active",
+        "annual_fee_pending_registration_completed"
+      ],
+      "readOnly"    : true
+    },
+    "lock_reason" : {
+      "description" : "Reason for card lock",
+      "type" : "string",
+      "enum" : [
+        "termination",
+        "compromised",
+        "lost",
+        "stolen",
+        "unneeded",
+        "better_offer",
+        "other_card",
+        "fraud"
+      ],
+      "readOnly"    : true
+    },
+    "disabled" : {
+      "description" : "Card disabled boolean",
+      "type"        : "boolean",
+      "readOnly"    : true
+    },
+    "created_at" : {
+      "$ref"        : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref"        : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "description" : "All cards of a customer",
+      "href"        : "cards",
+      "method"      : "GET",
+      "rel"         : "instances",
+      "title"       : "Index"
+    },
+    {
+      "description" : "Card details",
+      "href"        : "cards/{id}",
+      "method"      : "GET",
+      "rel"         : "self",
+      "title"       : "Show"
+    },
+    {
+      "description" : "Card PIN code",
+      "href"        : "cards/{id}/pin",
+      "method"      : "GET",
+      "rel"         : "pin",
+      "title"       : "PIN code",
+      "schema"      : "pin"
+    },
+    {
+      "description" : "Card PAN number",
+      "href"        : "cards/{id}/pan",
+      "method"      : "GET",
+      "rel"         : "pan",
+      "title"       : "Permanent Account Number"
+    },
+    {
+      "description" : "Lock a card",
+      "href"        : "cards/{id}/lock",
+      "method"      : "PUT",
+      "rel"         : "lock",
+      "title"       : "Lock"
+    },
+    {
+      "description" : "Unlock a card",
+      "href"        : "cards/{id}/unlock",
+      "method"      : "PUT",
+      "rel"         : "unlock",
+      "title"       : "Unlock"
+    },
+    {
+      "description" : "Block a card: in case of fraud / lost / stolen card",
+      "href"        : "cards/{id}/block",
+      "method"      : "PUT",
+      "rel"         : "block",
+      "title"       : "Block"
+    },
+    {
+      "description" : "Activate a new card",
+      "href"        : "cards/{id}/activate",
+      "method"      : "PUT",
+      "rel"         : "activate",
+      "title"       : "Activate",
+      "properties"  : {
+        "cvc_code" : {
+          "description" : "Card's pin",
+          "type"        : "string",
+          "pattern"     : "^[0-9]{3}$"
+        }
+      }
+    },
+    {
+      "description" : "Cancel an existing card: cancel card subscription, lock card",
+      "href"        : "cards/{id}/cancel",
+      "method"      : "PUT",
+      "rel"         : "cancel",
+      "title"       : "Cancel"
+    },
+    {
+      "description" : "Update limits of a card",
+      "href"        : "cards/{id}/limits",
+      "method"      : "PUT",
+      "rel"         : "limits",
+      "title"       : "Update Limits"
+    },
+    {
+      "description" : "Create a new card and initiate the order",
+      "href"        : "cards",
+      "method"      : "POST",
+      "rel"         : "create",
+      "title"       : "Create",
+      "properties"  : {
+        "pin" : {
+          "$ref" : "./card/pin.json#properties/pin"
+        }
+      }
+    }
+  ]
+}

data/schema/v1.0/creditor_identity.json

@@ -10,7 +10,7 @@
     "account_id" : {
       "description" : "An account creditor identities belong to",
       "$ref"        : "./base_types/base_types.json#definitions/account_id",
-      "readonly"    : true
+      "readOnly"    : true
     },
     "created_at" : {
       "$ref" : "./base_types/base_types.json#definitions/created_at"