diff --git a/obp-api/pom.xml b/obp-api/pom.xml index 225375fc4..45a16cea0 100644 --- a/obp-api/pom.xml +++ b/obp-api/pom.xml @@ -621,7 +621,7 @@ 1.2 false - ${basedir}/src/main/resources/protobuf + ${basedir}/src/main/protobuf ${basedir}/src/main/scala true diff --git a/obp-api/src/main/protobuf/api.proto b/obp-api/src/main/protobuf/api.proto new file mode 100644 index 000000000..ed828e3ae --- /dev/null +++ b/obp-api/src/main/protobuf/api.proto @@ -0,0 +1,233 @@ +syntax = "proto3"; + +package code.obp.grpc; +// +//import "scalapb/scalapb.proto"; +import "google/protobuf/empty.proto"; +import "google/protobuf/timestamp.proto"; + +//getBanks response +message BanksJson400Grpc { + repeated BankJson400Grpc banks = 1; + + message BankRoutingJsonV121Grpc { + string scheme = 1; + string address = 2; + } + message BankJson400Grpc{ + string id = 1; + string short_name = 2; + string full_name = 3; + string logo = 4; + string website = 5; + repeated BankRoutingJsonV121Grpc bank_routings = 6; + } +} + +message AccountsJSONGrpc { + repeated AccountJSONGrpc accounts = 1; +} + +message AccountJSONGrpc { + string id = 1; + string label = 2; + repeated ViewsJSONV121Grpc views_available = 3; + string bank_id = 4; +} + +message ViewsJSONV121Grpc{ + repeated ViewJSONV121Grpc views = 1; +} + +message ViewJSONV121Grpc { + string id = 1; + string short_name = 2; + string description = 3; + bool is_public = 4; + string alias = 5; + bool hide_metadata_if_alias_used = 6; + bool can_add_comment = 7; + bool can_add_corporate_location = 8; + bool can_add_image = 9; + bool can_add_image_url = 10; + bool can_add_more_info = 11; + bool can_add_open_corporates_url = 12; + bool can_add_physical_location = 13; + bool can_add_private_alias = 14; + bool can_add_public_alias = 15; + bool can_add_tag = 16; + bool can_add_url = 17; + bool can_add_where_tag = 18; + bool can_delete_comment = 19; + bool can_delete_corporate_location = 20; + bool can_delete_image = 21; + bool can_delete_physical_location = 22; + bool can_delete_tag = 23; + bool can_delete_where_tag = 24; + bool can_edit_owner_comment = 25; + bool can_see_bank_account_balance = 26; + bool can_see_bank_account_bank_name = 27; + bool can_see_bank_account_currency = 28; + bool can_see_bank_account_iban = 29; + bool can_see_bank_account_label = 30; + bool can_see_bank_account_national_identifier = 31; + bool can_see_bank_account_number = 32; + bool can_see_bank_account_owners = 33; + bool can_see_bank_account_swift_bic = 34; + bool can_see_bank_account_type = 35; + bool can_see_comments = 36; + bool can_see_corporate_location = 37; + bool can_see_image_url = 38; + bool can_see_images = 39; + bool can_see_more_info = 40; + bool can_see_open_corporates_url = 41; + bool can_see_other_account_bank_name = 42; + bool can_see_other_account_iban = 43; + bool can_see_other_account_kind = 44; + bool can_see_other_account_metadata = 45; + bool can_see_other_account_national_identifier = 46; + bool can_see_other_account_number = 47; + bool can_see_other_account_swift_bic = 48; + bool can_see_owner_comment = 49; + bool can_see_physical_location = 50; + bool can_see_private_alias = 51; + bool can_see_public_alias = 52; + bool can_see_tags = 53; + bool can_see_transaction_amount = 54; + bool can_see_transaction_balance = 55; + bool can_see_transaction_currency = 56; + bool can_see_transaction_description = 57; + bool can_see_transaction_finish_date = 58; + bool can_see_transaction_metadata = 59; + bool can_see_transaction_other_bank_account = 60; + bool can_see_transaction_start_date = 61; + bool can_see_transaction_this_bank_account = 62; + bool can_see_transaction_type = 63; + bool can_see_url = 64; + bool can_see_where_tag = 65; +} +// getAccounts +message AccountsGrpc { + repeated BasicAccountJSONGrpc accounts = 1; +} +message BasicAccountJSONGrpc { + message BasicViewJson { + string id = 1; + string short_name = 2; + bool is_public = 3; + } + string id = 1; + string label = 2; + string bank_id = 3; + repeated BasicViewJson views_available = 4; +} + +message BankIdGrpc { + string value = 1; + string userId = 2; +} + +message BankIdUserIdGrpc { + string bankId = 1; + string userId = 2; +} +message AccountIdGrpc { + string value = 1; +} + +message CoreTransactionsJsonV300Grpc { + repeated CoreTransactionJsonV300Grpc transactions = 1; + message CoreTransactionJsonV300Grpc { + string id = 1; + ThisAccountJsonV300Grpc this_account = 2; + CoreCounterpartyJsonV300Grpc other_account = 3; + CoreTransactionDetailsJSONGrpc details = 4; + } + message AccountHolderJSONGrpc { + string name = 1; + bool is_alias = 2; + } + message AccountRoutingJsonV121Grpc { + string scheme = 1; + string address = 2; + } + message BankRoutingJsonV121Grpc { + string scheme = 1; + string address = 2; + } + message ThisAccountJsonV300Grpc { + string id = 1; + BankRoutingJsonV121Grpc bank_routing = 2; + repeated AccountRoutingJsonV121Grpc account_routings = 3; + repeated AccountHolderJSONGrpc holders = 4; + } + message CoreCounterpartyJsonV300Grpc { + string id = 1; + AccountHolderJSONGrpc holder = 2; + BankRoutingJsonV121Grpc bank_routing = 3; + repeated AccountRoutingJsonV121Grpc account_routings = 4; + } + message AmountOfMoneyJsonV121Grpc{ + string currency = 1; + string amount = 2; + } + message CoreTransactionDetailsJSONGrpc { + string type = 1; + string description = 2; +// google.protobuf.Timestamp posted = 3; +// google.protobuf.Timestamp completed = 4; + string posted = 3; + string completed = 4; + AmountOfMoneyJsonV121Grpc new_balance = 5; + AmountOfMoneyJsonV121Grpc value = 6; + } +} + +message BankIdAndAccountIdGrpc { + string bankId = 1; + string accountId = 2; +} + +message BankIdAccountIdAndUserIdGrpc { + string bankId = 1; + string accountId = 2; + string userId = 3; +} + +// getBankAccountsBalances +message AccountsBalancesV310JsonGrpc { + repeated AccountBalanceV310Grpc accounts = 1; + AmountOfMoneyGrpc overall_balance = 2; + string overall_balance_date = 3; + + message AmountOfMoneyGrpc { + string currency = 1; + string amount = 2; + } + message AccountRoutingGrpc { + string scheme = 1; + string address = 2; +} + message AccountBalanceV310Grpc { + string id = 1; + string label = 2; + string bank_id = 3; + repeated AccountRoutingGrpc account_routings = 4; + AmountOfMoneyGrpc balance = 5; + } +} + +service ObpService { + // Sends a greeting + rpc getBanks(google.protobuf.Empty) returns (BanksJson400Grpc) {} + + //Returns the list of accounts at BANK_ID that the user has access to. + //For each account the API returns the account ID and the available views. + rpc getPrivateAccountsAtOneBank(BankIdUserIdGrpc) returns (AccountsGrpc) {} + + //Get the Balances for the Accounts of the current User at one bank. + rpc getBankAccountsBalances(BankIdGrpc) returns (AccountsBalancesV310JsonGrpc) {} + + //Returns transactions list (Core info) of the account specified by ACCOUNT_ID. + rpc getCoreTransactionsForBankAccount(BankIdAccountIdAndUserIdGrpc) returns (CoreTransactionsJsonV300Grpc) {} +} diff --git a/obp-api/src/main/protobuf/google/protobuf/empty.proto b/obp-api/src/main/protobuf/google/protobuf/empty.proto new file mode 100644 index 000000000..d675375e1 --- /dev/null +++ b/obp-api/src/main/protobuf/google/protobuf/empty.proto @@ -0,0 +1,52 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2008 Google Inc. All rights reserved. +// https://developers.google.com/protocol-buffers/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +syntax = "proto3"; + +package google.protobuf; + +option csharp_namespace = "Google.Protobuf.WellKnownTypes"; +option go_package = "github.com/golang/protobuf/ptypes/empty"; +option java_package = "com.google.protobuf"; +option java_outer_classname = "EmptyProto"; +option java_multiple_files = true; +option objc_class_prefix = "GPB"; +option cc_enable_arenas = true; + +// A generic empty message that you can re-use to avoid defining duplicated +// empty messages in your APIs. A typical example is to use it as the request +// or the response type of an API method. For instance: +// +// service Foo { +// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); +// } +// +// The JSON representation for `Empty` is empty JSON object `{}`. +message Empty {} \ No newline at end of file diff --git a/obp-api/src/main/protobuf/google/protobuf/timestamp.proto b/obp-api/src/main/protobuf/google/protobuf/timestamp.proto new file mode 100644 index 000000000..62b90f5f2 --- /dev/null +++ b/obp-api/src/main/protobuf/google/protobuf/timestamp.proto @@ -0,0 +1,138 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2008 Google Inc. All rights reserved. +// https://developers.google.com/protocol-buffers/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +syntax = "proto3"; + +package google.protobuf; + +option csharp_namespace = "Google.Protobuf.WellKnownTypes"; +option cc_enable_arenas = true; +option go_package = "github.com/golang/protobuf/ptypes/timestamp"; +option java_package = "com.google.protobuf"; +option java_outer_classname = "TimestampProto"; +option java_multiple_files = true; +option objc_class_prefix = "GPB"; + +// A Timestamp represents a point in time independent of any time zone or local +// calendar, encoded as a count of seconds and fractions of seconds at +// nanosecond resolution. The count is relative to an epoch at UTC midnight on +// January 1, 1970, in the proleptic Gregorian calendar which extends the +// Gregorian calendar backwards to year one. +// +// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap +// second table is needed for interpretation, using a [24-hour linear +// smear](https://developers.google.com/time/smear). +// +// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By +// restricting to that range, we ensure that we can convert to and from [RFC +// 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. +// +// # Examples +// +// Example 1: Compute Timestamp from POSIX `time()`. +// +// Timestamp timestamp; +// timestamp.set_seconds(time(NULL)); +// timestamp.set_nanos(0); +// +// Example 2: Compute Timestamp from POSIX `gettimeofday()`. +// +// struct timeval tv; +// gettimeofday(&tv, NULL); +// +// Timestamp timestamp; +// timestamp.set_seconds(tv.tv_sec); +// timestamp.set_nanos(tv.tv_usec * 1000); +// +// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. +// +// FILETIME ft; +// GetSystemTimeAsFileTime(&ft); +// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; +// +// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z +// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. +// Timestamp timestamp; +// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); +// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); +// +// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. +// +// long millis = System.currentTimeMillis(); +// +// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) +// .setNanos((int) ((millis % 1000) * 1000000)).build(); +// +// +// Example 5: Compute Timestamp from current time in Python. +// +// timestamp = Timestamp() +// timestamp.GetCurrentTime() +// +// # JSON Mapping +// +// In JSON format, the Timestamp type is encoded as a string in the +// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the +// format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" +// where {year} is always expressed using four digits while {month}, {day}, +// {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional +// seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), +// are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone +// is required. A proto3 JSON serializer should always use UTC (as indicated by +// "Z") when printing the Timestamp type and a proto3 JSON parser should be +// able to accept both UTC and other timezones (as indicated by an offset). +// +// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past +// 01:30 UTC on January 15, 2017. +// +// In JavaScript, one can convert a Date object to this format using the +// standard +// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) +// method. In Python, a standard `datetime.datetime` object can be converted +// to this format using +// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with +// the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use +// the Joda Time's [`ISODateTimeFormat.dateTime()`]( +// http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D +// ) to obtain a formatter capable of generating timestamps in this format. +// +// +message Timestamp { + // Represents seconds of UTC time since Unix epoch + // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to + // 9999-12-31T23:59:59Z inclusive. + int64 seconds = 1; + + // Non-negative fractions of a second at nanosecond resolution. Negative + // second values with fractions must still have non-negative nanos values + // that count forward in time. Must be from 0 to 999,999,999 + // inclusive. + int32 nanos = 2; +} \ No newline at end of file