diff --git a/.gitbook/assets/swagger (1).json b/.gitbook/assets/swagger (1).json new file mode 100644 index 0000000..2d10129 --- /dev/null +++ b/.gitbook/assets/swagger (1).json @@ -0,0 +1,2673 @@ +{ + "swagger": "2.0", + "info": { + "title": "MyDataCoinBridge.io", + "version": "v1" + }, + "paths": { + "/api/v1/BridgeStatistic/add": { + "post": { + "tags": [ + "BridgeStatistic" + ], + "summary": "add statistic from provider", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "token", + "type": "string" + }, + { + "in": "body", + "name": "body", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionProviderRequest" + } + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + } + } + }, + "/api/v1/BridgeStatistic/getFromProvider": { + "get": { + "tags": [ + "BridgeStatistic" + ], + "summary": "get statistic from provider", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "token", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionProviderResponse" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + } + } + }, + "/api/v1/BridgeStatistic/getFromAdmin": { + "get": { + "tags": [ + "BridgeStatistic" + ], + "summary": "get statistic from admin", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionProviderResponse" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + } + } + }, + "/api/v1/BridgeStatistic/claim/{userId}": { + "get": { + "tags": [ + "BridgeStatistic" + ], + "summary": "claim USDMDC from user", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "format": "double", + "type": "number" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + } + } + }, + "/api/v1/Providers/get-provider-by-id/{id}": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Get provider by id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/DataProvider" + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/get-users-providers/{countryCode}/{userId}": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Get providers by country code (KG, KZ)", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "countryCode", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "userId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Country" + } + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/LoginGoogle": { + "get": { + "tags": [ + "Providers" + ], + "summary": "LoginGoogle", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "deprecated": true + } + }, + "/api/v1/Providers/SignIn": { + "get": { + "tags": [ + "Providers" + ], + "summary": "SignIn", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "code", + "type": "string" + }, + { + "in": "query", + "name": "scope", + "type": "string" + }, + { + "in": "query", + "name": "state", + "type": "string", + "default": "" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "deprecated": true + } + }, + "/api/v1/Providers/LoginFacebook": { + "get": { + "tags": [ + "Providers" + ], + "summary": "LoginFacebook", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "deprecated": true + } + }, + "/api/v1/Providers/LoginFacebookSignIn": { + "get": { + "tags": [ + "Providers" + ], + "summary": "LoginFacebookSignIn", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "code", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "deprecated": true + } + }, + "/api/v1/Providers/GetPersonInfoGoogle": { + "get": { + "tags": [ + "Providers" + ], + "summary": "GetPersonInfoGoogle", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "accessToken", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "deprecated": true + } + }, + "/api/v1/Providers/DataProviderCreate": { + "post": { + "tags": [ + "Providers" + ], + "summary": "CRUD Create Data Provider", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DataProviderRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/DataProviderEdit/{Id}": { + "put": { + "tags": [ + "Providers" + ], + "summary": "CRUD Edit Data Provider", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DataProviderRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/DataProviderGet": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Data Provider by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "token", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/DataProviderRequest" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/DataProviderGetList": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Data Provider List", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DataProviderRequest" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/DataProviderDelete/{Id}": { + "delete": { + "tags": [ + "Providers" + ], + "summary": "CRUD Delete Data Provider by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/RewardCategoryCreate": { + "post": { + "tags": [ + "Providers" + ], + "summary": "CRUD Create Reward Category", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/RewardCategoryRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/RewardCategoryEdit/{Id}": { + "put": { + "tags": [ + "Providers" + ], + "summary": "CRUD Edit Reward Category", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/RewardCategoryRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/RewardCategoryGet/{Id}": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Reward Category by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/RewardCategoryGetList": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Reward Category List", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/RewardCategoryDelete/{Id}": { + "delete": { + "tags": [ + "Providers" + ], + "summary": "CRUD Delete Reward Category by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/TransactionCreate": { + "post": { + "tags": [ + "Providers" + ], + "summary": "CRUD Create Transaction", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/TransactionRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TransactionEdit/{Id}": { + "put": { + "tags": [ + "Providers" + ], + "summary": "CRUD Edit Transaction", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/TransactionRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TransactionGet/{Id}": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Transaction by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/TransactionRequest" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TransactionGetList": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Transaction List", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/GETLISTCountry": { + "get": { + "tags": [ + "Providers" + ], + "summary": "CRUD Get Country List", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CountryRequest" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TransactionDelete/{Id}": { + "delete": { + "tags": [ + "Providers" + ], + "summary": "CRUD Delete Transaction by Id", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/TermsOfUse": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Get the terms of use status for user from provider", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "fio", + "type": "string" + }, + { + "in": "query", + "name": "userId", + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "provaiderId", + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TermsOfUseExtended": { + "post": { + "tags": [ + "Providers" + ], + "summary": "Get extended status for user from provider's terms of use", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/TermOfUseRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/TermOfUseApply": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Agree to the terms of use", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "userId", + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "providerId", + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/TermOfUseCancel": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Refuse terms of services with provider", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "userId", + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "providerId", + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Providers/GetStatistics": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Get statistics for user", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "userId", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/AllDataFromStatisticRequest" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/GetStatisticsExtend": { + "get": { + "tags": [ + "Providers" + ], + "summary": "Get statistics for user extended", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "userId", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "$ref": "#/definitions/AllDataFromStatisticRequest" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "401": { + "description": "Returns Unauthorized" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "421": { + "description": "Returns User Not Found" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/Providers/upload_logo": { + "post": { + "tags": [ + "Providers" + ], + "summary": "Upload logo", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/Uploadrequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + } + } + } + }, + "/api/v1/User/send_code/{email}": { + "get": { + "tags": [ + "User" + ], + "summary": "User authentication by email, needs to authenticate managers", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "email", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/verify_code": { + "post": { + "tags": [ + "User" + ], + "summary": "Verify code sent by system to get JWT", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/VerifyCodeRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/refresh": { + "post": { + "tags": [ + "User" + ], + "summary": "Verify code sent by system to get JWT", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/Tokens" + } + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/registration/{email}": { + "post": { + "tags": [ + "User" + ], + "summary": "Registration", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "email", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/verify/{email}": { + "post": { + "tags": [ + "User" + ], + "summary": "Verify", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "email", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/verify": { + "post": { + "tags": [ + "User" + ], + "summary": "Verify request for user", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "token", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/list": { + "post": { + "tags": [ + "User" + ], + "summary": "List", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/User/UpToManager": { + "post": { + "tags": [ + "User" + ], + "summary": "Verify", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "query", + "name": "userId", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/VerifyCodeResponse" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + }, + "/api/v1/WebHooks/subscribe": { + "post": { + "tags": [ + "WebHooks" + ], + "summary": "Subscribe", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SubscribeRequest" + } + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "204": { + "description": "Returns User Not Found", + "schema": { + "$ref": "#/definitions/NoContentResult" + } + }, + "400": { + "description": "Returns Bad Request", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "415": { + "description": "Returns Unsupported Media Type", + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeResult" + } + }, + "500": { + "description": "Returns Internal Server Error", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + } + } + } + }, + "/api/v1/WebHooks/unsubscribe/{token}": { + "get": { + "tags": [ + "WebHooks" + ], + "summary": "Unsubscribe", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "parameters": [ + { + "in": "path", + "name": "token", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns Ok", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "400": { + "description": "Returns Bad Request" + }, + "415": { + "description": "Returns Unsupported Media Type" + }, + "500": { + "description": "Returns Internal Server Error" + } + } + } + } + }, + "definitions": { + "AllDataFromStatisticRequest": { + "type": "object", + "properties": { + "totalEarneds": { + "type": "array", + "items": { + "$ref": "#/definitions/TotalEarned" + } + }, + "totalTransactions": { + "type": "array", + "items": { + "$ref": "#/definitions/TransactionRequest" + } + } + } + }, + "BasicData": { + "type": "object", + "properties": { + "interests": { + "type": "array", + "items": { + "type": "string" + } + }, + "languages": { + "type": "array", + "items": { + "type": "string" + } + }, + "religionViews": { + "type": "array", + "items": { + "type": "string" + } + }, + "politicalViews": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "BridgeUser": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "email": { + "type": "string" + }, + "role": { + "$ref": "#/definitions/Roles" + }, + "verificationCode": { + "type": "string" + }, + "isVerified": { + "$ref": "#/definitions/VerifiedEnum" + }, + "tokenForService": { + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "secret": { + "type": "string", + "readOnly": true + } + } + }, + "Contacts": { + "type": "object", + "properties": { + "mobilePhone": { + "type": "string" + }, + "address": { + "type": "string" + }, + "linkedAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "website": { + "type": "string" + } + } + }, + "Country": { + "required": [ + "countryCode", + "countryName" + ], + "type": "object", + "properties": { + "countryName": { + "description": "Country name\r\nRussia", + "minLength": 1, + "type": "string" + }, + "countryCode": { + "description": "Country code by ISO\r\nRUS", + "minLength": 1, + "type": "string" + }, + "phoneCode": { + "description": "Country phone code by ISO\r\n+996", + "type": "string" + }, + "dataProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/DataProvider" + } + } + } + }, + "CountryRequest": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "countryName": { + "type": "string" + }, + "countryCode": { + "type": "string" + }, + "phoneCode": { + "type": "string" + } + } + }, + "DataProvider": { + "description": "It is assumed that if one provider is present in more than one country,\r\nthen another provider should be created for each country.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "bridgeUser": { + "$ref": "#/definitions/BridgeUser" + }, + "bridgeUserId": { + "format": "uuid", + "type": "string" + }, + "icon": { + "type": "string" + }, + "address": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "email": { + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "rewardCategories": { + "type": "array", + "items": { + "$ref": "#/definitions/RewardCategory" + } + }, + "countries": { + "type": "array", + "items": { + "$ref": "#/definitions/Country" + } + } + } + }, + "DataProviderRequest": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "address": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "email": { + "type": "string" + }, + "bridgeUserId": { + "type": "string" + }, + "token": { + "type": "string" + }, + "connected": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "rewardCategories": { + "type": "array", + "items": { + "$ref": "#/definitions/RewardCategoryRequest" + } + }, + "countries": { + "type": "array", + "items": { + "$ref": "#/definitions/CountryRequest" + } + }, + "verificationCode": { + "type": "string" + }, + "isVerified": { + "$ref": "#/definitions/VerifiedEnum" + }, + "bridgeUserEmail": { + "type": "string" + } + } + }, + "GeneralResponse": { + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "The HTTP Status Code", + "type": "integer", + "example": 200 + }, + "message": { + "description": "The Message from response" + } + } + }, + "NoContentResult": { + "type": "object", + "properties": { + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "PersonalInterests": { + "type": "object", + "properties": { + "breifDescription": { + "type": "string" + }, + "hobby": { + "type": "array", + "items": { + "type": "string" + } + }, + "sport": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PlaceOfResidence": { + "type": "object", + "properties": { + "currentCity": { + "type": "string" + }, + "birthPlace": { + "type": "string" + }, + "otherCities": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Profile": { + "type": "object", + "properties": { + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "dateOfBirth": { + "format": "date-time", + "type": "string" + }, + "gender": { + "format": "int32", + "type": "integer" + }, + "email": { + "type": "array", + "items": { + "type": "string" + } + }, + "phone": { + "type": "array", + "items": { + "type": "string" + } + }, + "basicData": { + "$ref": "#/definitions/BasicData" + }, + "contacts": { + "$ref": "#/definitions/Contacts" + }, + "workAndEducation": { + "$ref": "#/definitions/WorkAndEducation" + }, + "placeOfResidence": { + "$ref": "#/definitions/PlaceOfResidence" + }, + "personalInterests": { + "$ref": "#/definitions/PersonalInterests" + } + } + }, + "RewardCategory": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Unique identifier of reward category\r\ne12318b4-dbc7-4d18-87c2-100bed209dce", + "type": "string" + }, + "name": { + "description": "Enum of reward category\r\nClick", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "Description of reward category\r\nReward description", + "type": "string" + } + } + }, + "RewardCategoryRequest": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Roles": { + "format": "int32", + "enum": [ + 0, + 1, + 2 + ], + "type": "integer" + }, + "SubscribeRequest": { + "required": [ + "token", + "url" + ], + "type": "object", + "properties": { + "token": { + "description": "Access Token from adminpanel\r\n$2a$11$345F#lBpXelQlWknng4JGeU4c.UnjEZii#%$g#wMnLwvAey.dd", + "minLength": 1, + "type": "string" + }, + "url": { + "format": "uri", + "description": "URL of your service which will return personal data\r\nhttps://yourwebsite/api/v1/pd_request", + "minLength": 1, + "type": "string" + } + } + }, + "TermOfUseRequest": { + "type": "object", + "properties": { + "userId": { + "format": "uuid", + "type": "string" + }, + "provaiderId": { + "format": "uuid", + "type": "string" + }, + "email": { + "type": "array", + "items": { + "type": "string" + } + }, + "phone": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Tokens": { + "type": "object", + "properties": { + "access_Token": { + "type": "string" + }, + "refresh_Token": { + "type": "string" + } + } + }, + "TotalEarned": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "amount": { + "format": "double", + "type": "number" + } + } + }, + "TransactionProviderRequest": { + "type": "object", + "properties": { + "emailPhone": { + "type": "string" + }, + "rewardCategoryId": { + "type": "string" + }, + "count": { + "format": "double", + "type": "number" + } + } + }, + "TransactionProviderResponse": { + "type": "object", + "properties": { + "emailPhone": { + "type": "string" + }, + "rewardCategoryName": { + "type": "string" + }, + "count": { + "format": "double", + "type": "number" + }, + "usdmcdAmount": { + "format": "double", + "type": "number" + }, + "created": { + "format": "date-time", + "type": "string" + } + } + }, + "TransactionRequest": { + "type": "object", + "properties": { + "txId": { + "format": "uuid", + "type": "string" + }, + "from": { + "type": "string" + }, + "to": { + "type": "string" + }, + "amount": { + "format": "double", + "type": "number" + }, + "txDate": { + "format": "date-time", + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "UnsupportedMediaTypeResult": { + "type": "object", + "properties": { + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "Uploadrequest": { + "type": "object", + "properties": { + "token": { + "type": "string" + }, + "imageData": { + "type": "string" + }, + "extension": { + "type": "string" + } + } + }, + "VerifiedEnum": { + "format": "int32", + "enum": [ + 0, + 1, + 2 + ], + "type": "integer" + }, + "VerifyCodeRequest": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "code": { + "type": "string" + } + } + }, + "VerifyCodeResponse": { + "type": "object", + "properties": { + "tokens": { + "$ref": "#/definitions/Tokens" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + }, + "role": { + "type": "string" + }, + "email": { + "type": "string" + }, + "token": { + "type": "string" + }, + "isVerified": { + "$ref": "#/definitions/VerifiedEnum" + } + } + }, + "WorkAndEducation": { + "type": "object", + "properties": { + "placeOfWork": { + "type": "string" + }, + "skills": { + "type": "array", + "items": { + "type": "string" + } + }, + "university": { + "type": "string" + }, + "faculty": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "Bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "JWT Authorization header using the Bearer scheme. \\r\\n\\r\\n \n Enter 'Bearer' [space] and then your token in the text input below.\n \\r\\n\\r\\nExample: 'Bearer 12345abcdef'" + } + } +} \ No newline at end of file diff --git a/.gitbook/assets/swagger.json b/.gitbook/assets/swagger.json index 2d10129..f48f80d 100644 --- a/.gitbook/assets/swagger.json +++ b/.gitbook/assets/swagger.json @@ -1,16 +1,16 @@ { "swagger": "2.0", "info": { - "title": "MyDataCoinBridge.io", + "title": "MDC-SF.io", "version": "v1" }, "paths": { - "/api/v1/BridgeStatistic/add": { + "/api/v1/Application/create-application": { "post": { "tags": [ - "BridgeStatistic" + "Application" ], - "summary": "add statistic from provider", + "summary": "Create application", "consumes": [ "application/json-patch+json", "application/json", @@ -25,17 +25,14 @@ "parameters": [ { "in": "query", - "name": "token", + "name": "employeeId", "type": "string" }, { "in": "body", "name": "body", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionProviderRequest" - } + "$ref": "#/definitions/CreateApplicationRequest" } } ], @@ -46,97 +43,35 @@ "$ref": "#/definitions/GeneralResponse" } }, - "400": { - "description": "Returns Bad Request" - }, "401": { "description": "Returns Unauthorized" }, - "415": { - "description": "Returns Unsupported Media Type" - } - } - } - }, - "/api/v1/BridgeStatistic/getFromProvider": { - "get": { - "tags": [ - "BridgeStatistic" - ], - "summary": "get statistic from provider", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "query", - "name": "token", - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionProviderResponse" - } - } + "403": { + "description": "Forbidden" }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" } - } - } - }, - "/api/v1/BridgeStatistic/getFromAdmin": { - "get": { - "tags": [ - "BridgeStatistic" - ], - "summary": "get statistic from admin", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionProviderResponse" - } - } - }, - "400": { - "description": "Returns Bad Request" - }, - "401": { - "description": "Returns Unauthorized" - }, - "415": { - "description": "Returns Unsupported Media Type" + }, + "security": [ + { + "Bearer": [ ] } - } + ] } }, - "/api/v1/BridgeStatistic/claim/{userId}": { + "/api/v1/Application/get-application-by-id/{id}": { "get": { "tags": [ - "BridgeStatistic" + "Application" ], - "summary": "claim USDMDC from user", + "summary": "Get application by id", "produces": [ "text/plain", "application/json", @@ -145,7 +80,7 @@ "parameters": [ { "in": "path", - "name": "userId", + "name": "id", "required": true, "type": "string" } @@ -154,28 +89,38 @@ "200": { "description": "Returns Success", "schema": { - "format": "double", - "type": "number" + "$ref": "#/definitions/Application" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/get-provider-by-id/{id}": { + "/api/v1/Application/get-application-by-application-number": { "get": { "tags": [ - "Providers" + "Application" ], - "summary": "Get provider by id", + "summary": "Get application by appliction number", "produces": [ "text/plain", "application/json", @@ -183,9 +128,8 @@ ], "parameters": [ { - "in": "path", - "name": "id", - "required": true, + "in": "query", + "name": "applicationNumber", "type": "string" } ], @@ -193,7 +137,7 @@ "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/DataProvider" + "$ref": "#/definitions/Application" } }, "401": { @@ -205,6 +149,9 @@ "400": { "description": "Returns Bad Request" }, + "404": { + "description": "Returns Not Found" + }, "415": { "description": "Returns Unsupported Media Type" } @@ -216,38 +163,24 @@ ] } }, - "/api/v1/Providers/get-users-providers/{countryCode}/{userId}": { + "/api/v1/Application/get-all-applications": { "get": { "tags": [ - "Providers" + "Application" ], - "summary": "Get providers by country code (KG, KZ)", + "summary": "Get all applications", "produces": [ "text/plain", "application/json", "text/json" ], - "parameters": [ - { - "in": "path", - "name": "countryCode", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "userId", - "required": true, - "type": "string" - } - ], "responses": { "200": { "description": "Returns Success", "schema": { "type": "array", "items": { - "$ref": "#/definitions/Country" + "$ref": "#/definitions/Application" } } }, @@ -271,49 +204,12 @@ ] } }, - "/api/v1/Providers/LoginGoogle": { - "get": { - "tags": [ - "Providers" - ], - "summary": "LoginGoogle", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "401": { - "description": "Returns Unauthorized" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" - } - }, - "deprecated": true - } - }, - "/api/v1/Providers/SignIn": { + "/api/v1/Application/get-applications-by-pin": { "get": { "tags": [ - "Providers" + "Application" ], - "summary": "SignIn", + "summary": "Get applications by pin", "produces": [ "text/plain", "application/json", @@ -322,26 +218,29 @@ "parameters": [ { "in": "query", - "name": "code", - "type": "string" + "name": "page", + "type": "integer", + "format": "int32", + "default": 1 }, { "in": "query", - "name": "scope", - "type": "string" + "name": "pageSize", + "type": "integer", + "format": "int32", + "default": 10 }, { "in": "query", - "name": "state", - "type": "string", - "default": "" + "name": "inn", + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/ApplicationPageModel" } }, "400": { @@ -352,28 +251,36 @@ }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } - }, - "deprecated": true + } } }, - "/api/v1/Providers/LoginFacebook": { - "get": { + "/api/v1/Application/change-application-status": { + "post": { "tags": [ - "Providers" + "Application" + ], + "summary": "Change application status", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" ], - "summary": "LoginFacebook", "produces": [ "text/plain", "application/json", "text/json" ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChangeStatusRequest" + } + } + ], "responses": { "200": { "description": "Returns Success", @@ -381,31 +288,35 @@ "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, - "deprecated": true + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/LoginFacebookSignIn": { - "get": { + "/api/v1/Application/set-allowance": { + "post": { "tags": [ - "Providers" + "Application" ], - "summary": "LoginFacebookSignIn", + "summary": "Set allowance to application", "produces": [ "text/plain", "application/json", @@ -414,7 +325,17 @@ "parameters": [ { "in": "query", - "name": "code", + "name": "applicationNumber", + "type": "string" + }, + { + "in": "query", + "name": "status", + "type": "boolean" + }, + { + "in": "query", + "name": "comment", "type": "string" } ], @@ -425,31 +346,35 @@ "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, - "deprecated": true + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/GetPersonInfoGoogle": { - "get": { + "/api/v1/Application/revoke-by-user-request": { + "post": { "tags": [ - "Providers" + "Application" ], - "summary": "GetPersonInfoGoogle", + "summary": "Revoke application by client request", "produces": [ "text/plain", "application/json", @@ -458,7 +383,12 @@ "parameters": [ { "in": "query", - "name": "accessToken", + "name": "applicationNumber", + "type": "string" + }, + { + "in": "query", + "name": "comment", "type": "string" } ], @@ -469,31 +399,35 @@ "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, - "deprecated": true + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/DataProviderCreate": { - "post": { + "/api/v1/Application/update-application": { + "put": { "tags": [ - "Providers" + "Application" ], - "summary": "CRUD Create Data Provider", + "summary": "Update application by application number", "consumes": [ "application/json-patch+json", "application/json", @@ -506,11 +440,16 @@ "text/json" ], "parameters": [ + { + "in": "query", + "name": "applicationNumber", + "type": "string" + }, { "in": "body", "name": "body", "schema": { - "$ref": "#/definitions/DataProviderRequest" + "$ref": "#/definitions/UpdateApplicationRequest" } } ], @@ -521,88 +460,35 @@ "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } - } - } - }, - "/api/v1/Providers/DataProviderEdit/{Id}": { - "put": { - "tags": [ - "Providers" - ], - "summary": "CRUD Edit Data Provider", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" - ], - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" - }, + }, + "security": [ { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/DataProviderRequest" - } - } - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "401": { - "description": "Returns Unauthorized" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" + "Bearer": [ ] } - } + ] } }, - "/api/v1/Providers/DataProviderGet": { + "/api/v1/Application/get-filtered-applications": { "get": { "tags": [ - "Providers" + "Application" ], - "summary": "CRUD Get Data Provider by Id", + "summary": "Get applications with pagination", "produces": [ "text/plain", "application/json", @@ -611,45 +497,62 @@ "parameters": [ { "in": "query", - "name": "token", + "name": "page", + "type": "integer", + "format": "int32", + "default": 1 + }, + { + "in": "query", + "name": "pageSize", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "in": "query", + "name": "bankName", "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "$ref": "#/definitions/DataProviderRequest" - } }, - "400": { - "description": "Returns Bad Request" + { + "in": "query", + "name": "categoryType", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" }, - "401": { - "description": "Returns Unauthorized" + { + "in": "query", + "name": "status", + "type": "string" }, - "415": { - "description": "Returns Unsupported Media Type" + { + "in": "query", + "name": "inn", + "type": "string" }, - "421": { - "description": "Returns User Not Found" + { + "in": "query", + "name": "fromDate", + "type": "string" }, - "500": { - "description": "Returns Internal Server Error" + { + "in": "query", + "name": "toDate", + "type": "string" + }, + { + "in": "query", + "name": "name", + "type": "string" + }, + { + "in": "query", + "name": "applicationNumber", + "type": "string" } - } - } - }, - "/api/v1/Providers/DataProviderGetList": { - "get": { - "tags": [ - "Providers" - ], - "summary": "CRUD Get Data Provider List", - "produces": [ - "text/plain", - "application/json", - "text/json" ], "responses": { "200": { @@ -657,7 +560,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/definitions/DataProviderRequest" + "$ref": "#/definitions/ApplicationDto" } } }, @@ -669,22 +572,22 @@ }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/DataProviderDelete/{Id}": { - "delete": { + "/api/v1/Kyc/save-photo": { + "post": { "tags": [ - "Providers" + "Kyc" + ], + "summary": "Π‘ΠΎΡ…Ρ€Π°Π½Π΅Π½ΠΈΠ΅ KYC заявки", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" ], - "summary": "CRUD Delete Data Provider by Id", "produces": [ "text/plain", "application/json", @@ -692,11 +595,16 @@ ], "parameters": [ { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" + "in": "query", + "name": "applicationNumber", + "type": "string" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/KycRequestModel" + } } ], "responses": { @@ -706,23 +614,50 @@ "$ref": "#/definitions/GeneralResponse" } }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "422": { + "description": "Unprocessable Content", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "423": { + "description": "Locked", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "433": { + "description": "Client Error", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "456": { + "description": "Client Error", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, + "500": { + "description": "Returns Internal Server Error", + "schema": { + "$ref": "#/definitions/GeneralResponse" + } + }, "401": { - "description": "Returns Unauthorized" + "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, "security": [ @@ -732,12 +667,12 @@ ] } }, - "/api/v1/Providers/RewardCategoryCreate": { + "/api/v1/Request/request-data": { "post": { "tags": [ - "Providers" + "Request" ], - "summary": "CRUD Create Reward Category", + "summary": "Request Data", "consumes": [ "application/json-patch+json", "application/json", @@ -754,7 +689,7 @@ "in": "body", "name": "body", "schema": { - "$ref": "#/definitions/RewardCategoryRequest" + "$ref": "#/definitions/RequestDataModel" } } ], @@ -765,36 +700,35 @@ "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/RewardCategoryEdit/{Id}": { - "put": { + "/api/v1/Request/get-report-by-bank": { + "get": { "tags": [ - "Providers" - ], - "summary": "CRUD Edit Reward Category", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" + "Request" ], + "summary": "Get report by bank", "produces": [ "text/plain", "application/json", @@ -802,25 +736,26 @@ ], "parameters": [ { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" + "in": "query", + "name": "bankName", + "type": "string" }, { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/RewardCategoryRequest" - } + "in": "query", + "name": "fromDate", + "type": "string" + }, + { + "in": "query", + "name": "toDate", + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/GetRequestByBankModel" } }, "401": { @@ -834,12 +769,6 @@ }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, "security": [ @@ -849,12 +778,12 @@ ] } }, - "/api/v1/Providers/RewardCategoryGet/{Id}": { + "/api/v1/Request/get-detailed-report-by-bank": { "get": { "tags": [ - "Providers" + "Request" ], - "summary": "CRUD Get Reward Category by Id", + "summary": "Get detailed report by bank", "produces": [ "text/plain", "application/json", @@ -862,80 +791,173 @@ ], "parameters": [ { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" + "in": "query", + "name": "page", + "type": "integer", + "format": "int32", + "default": 1 + }, + { + "in": "query", + "name": "pageSize", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "in": "query", + "name": "bankName", + "type": "string" + }, + { + "in": "query", + "name": "fromDate", + "type": "string" + }, + { + "in": "query", + "name": "toDate", + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/GetDetailRequestByBankPageModel" } }, - "400": { - "description": "Returns Bad Request" - }, "401": { "description": "Returns Unauthorized" }, - "415": { - "description": "Returns Unsupported Media Type" + "403": { + "description": "Forbidden" }, - "421": { - "description": "Returns User Not Found" + "400": { + "description": "Returns Bad Request" }, - "500": { - "description": "Returns Internal Server Error" + "415": { + "description": "Returns Unsupported Media Type" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/RewardCategoryGetList": { + "/api/v1/Request/get-all-reports": { "get": { "tags": [ - "Providers" + "Request" ], - "summary": "CRUD Get Reward Category List", + "summary": "Get all reports", "produces": [ "text/plain", "application/json", "text/json" ], + "parameters": [ + { + "in": "query", + "name": "page", + "type": "integer", + "format": "int32", + "default": 1 + }, + { + "in": "query", + "name": "pageSize", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "in": "query", + "name": "fromDate", + "type": "string" + }, + { + "in": "query", + "name": "toDate", + "type": "string" + } + ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/GetRequestSummaryPageModelRequest" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, + "415": { + "description": "Returns Unsupported Media Type" + } + }, + "security": [ + { + "Bearer": [ ] + } + ] + } + }, + "/api/v1/Request/get-last-statics": { + "get": { + "tags": [ + "Request" + ], + "summary": "Get amount by bank", + "produces": [ + "text/plain", + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "Returns Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Request" + } + } + }, "401": { "description": "Returns Unauthorized" }, - "415": { - "description": "Returns Unsupported Media Type" + "403": { + "description": "Forbidden" }, - "421": { - "description": "Returns User Not Found" + "400": { + "description": "Returns Bad Request" }, - "500": { - "description": "Returns Internal Server Error" + "415": { + "description": "Returns Unsupported Media Type" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/RewardCategoryDelete/{Id}": { - "delete": { + "/api/v1/Request/get-filtered-requests": { + "get": { "tags": [ - "Providers" + "Request" ], - "summary": "CRUD Delete Reward Category by Id", + "summary": "Get requests with pagination", "produces": [ "text/plain", "application/json", @@ -943,18 +965,48 @@ ], "parameters": [ { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" + "in": "query", + "name": "page", + "type": "integer", + "format": "int32", + "default": 1 + }, + { + "in": "query", + "name": "pageSize", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "in": "query", + "name": "bankName", + "type": "string" + }, + { + "in": "query", + "name": "fromDate", + "type": "string" + }, + { + "in": "query", + "name": "toDate", + "type": "string" + }, + { + "in": "query", + "name": "requesterType", + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "type": "array", + "items": { + "$ref": "#/definitions/Request" + } } }, "401": { @@ -968,12 +1020,6 @@ }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, "security": [ @@ -983,18 +1029,12 @@ ] } }, - "/api/v1/Providers/TransactionCreate": { - "post": { + "/api/v1/Request/get-info-of-citizen": { + "get": { "tags": [ - "Providers" - ], - "summary": "CRUD Create Transaction", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" + "Request" ], + "summary": "Get information on personal data of citizens", "produces": [ "text/plain", "application/json", @@ -1002,44 +1042,47 @@ ], "parameters": [ { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/TransactionRequest" - } + "in": "query", + "name": "pin", + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "type": "array", + "items": { + "$ref": "#/definitions/GeneralResponse" + } } }, - "400": { - "description": "Returns Bad Request" - }, "401": { "description": "Returns Unauthorized" }, - "415": { - "description": "Returns Unsupported Media Type" + "403": { + "description": "Forbidden" }, - "421": { - "description": "Returns User Not Found" + "400": { + "description": "Returns Bad Request" }, - "500": { - "description": "Returns Internal Server Error" + "415": { + "description": "Returns Unsupported Media Type" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/TransactionEdit/{Id}": { - "put": { + "/api/v1/User/registration": { + "post": { "tags": [ - "Providers" + "User" ], - "summary": "CRUD Edit Transaction", + "summary": "Registration", "consumes": [ "application/json-patch+json", "application/json", @@ -1052,52 +1095,39 @@ "text/json" ], "parameters": [ - { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" - }, { "in": "body", "name": "body", "schema": { - "$ref": "#/definitions/TransactionRequest" + "$ref": "#/definitions/UserRegistrationRequest" } } ], "responses": { "200": { - "description": "Returns Success", + "description": "Returns Ok", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/VerifyCodeResponse" } }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" - }, "415": { "description": "Returns Unsupported Media Type" }, - "421": { - "description": "Returns User Not Found" - }, "500": { "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/TransactionGet/{Id}": { - "get": { + "/api/v1/User/login": { + "post": { "tags": [ - "Providers" + "User" ], - "summary": "CRUD Get Transaction by Id", + "summary": "User authentication by email and password", "produces": [ "text/plain", "application/json", @@ -1105,122 +1135,133 @@ ], "parameters": [ { - "in": "path", - "name": "Id", - "required": true, - "type": "string", - "format": "uuid" + "in": "query", + "name": "email", + "type": "string" + }, + { + "in": "query", + "name": "password", + "type": "string" } ], "responses": { "200": { - "description": "Returns Success", + "description": "Returns Ok", "schema": { - "$ref": "#/definitions/TransactionRequest" + "$ref": "#/definitions/UserResponse" } }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" }, - "421": { - "description": "Returns User Not Found" - }, "500": { "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/TransactionGetList": { + "/api/v1/User/send-code/{email}": { "get": { "tags": [ - "Providers" + "User" ], - "summary": "CRUD Get Transaction List", + "summary": "Send code for verification", "produces": [ "text/plain", "application/json", "text/json" ], + "parameters": [ + { + "in": "path", + "name": "email", + "required": true, + "type": "string" + } + ], "responses": { "200": { - "description": "Returns Success", + "description": "Returns Ok", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionRequest" - } + "$ref": "#/definitions/GeneralResponse" } }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" }, - "421": { - "description": "Returns User Not Found" - }, "500": { "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/GETLISTCountry": { - "get": { + "/api/v1/User/verify-code": { + "post": { "tags": [ - "Providers" + "User" + ], + "summary": "Verify code", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" ], - "summary": "CRUD Get Country List", "produces": [ "text/plain", "application/json", "text/json" ], + "parameters": [ + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/VerifyCodeRequest" + } + } + ], "responses": { "200": { - "description": "Returns Success", + "description": "Returns Ok", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/CountryRequest" - } + "$ref": "#/definitions/GeneralResponse" } }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" }, - "421": { - "description": "Returns User Not Found" - }, "500": { "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/TransactionDelete/{Id}": { - "delete": { + "/api/v1/User/get-user-by-id/{userId}": { + "get": { "tags": [ - "Providers" + "User" ], - "summary": "CRUD Delete Transaction by Id", + "summary": "Get User by Id", "produces": [ "text/plain", "application/json", @@ -1229,17 +1270,16 @@ "parameters": [ { "in": "path", - "name": "Id", + "name": "userId", "required": true, - "type": "string", - "format": "uuid" + "type": "string" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "$ref": "#/definitions/UserResponse" } }, "401": { @@ -1251,14 +1291,11 @@ "400": { "description": "Returns Bad Request" }, + "404": { + "description": "Returns Not Found" + }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, "security": [ @@ -1268,12 +1305,18 @@ ] } }, - "/api/v1/Providers/TermsOfUse": { - "get": { + "/api/v1/User/change-password": { + "post": { "tags": [ - "Providers" + "User" + ], + "summary": "Change password", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" ], - "summary": "Get the terms of use status for user from provider", "produces": [ "text/plain", "application/json", @@ -1281,57 +1324,49 @@ ], "parameters": [ { - "in": "query", - "name": "fio", - "type": "string" - }, - { - "in": "query", - "name": "userId", - "type": "string", - "format": "uuid" - }, - { - "in": "query", - "name": "provaiderId", - "type": "string", - "format": "uuid" + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChangePasswordRequest" + } } ], "responses": { "200": { "description": "Returns Success", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionRequest" - } + "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/Providers/TermsOfUseExtended": { + "/api/v1/User/reset-password": { "post": { "tags": [ - "Providers" + "User" ], - "summary": "Get extended status for user from provider's terms of use", + "summary": "Reset password", "consumes": [ "application/json-patch+json", "application/json", @@ -1348,7 +1383,7 @@ "in": "body", "name": "body", "schema": { - "$ref": "#/definitions/TermOfUseRequest" + "$ref": "#/definitions/ResetPasswordRequest" } } ], @@ -1356,63 +1391,7 @@ "200": { "description": "Returns Success", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionRequest" - } - } - }, - "400": { - "description": "Returns Bad Request" - }, - "401": { - "description": "Returns Unauthorized" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/Providers/TermOfUseApply": { - "get": { - "tags": [ - "Providers" - ], - "summary": "Agree to the terms of use", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "query", - "name": "userId", - "type": "string", - "format": "uuid" - }, - { - "in": "query", - "name": "providerId", - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Returns Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionRequest" - } + "$ref": "#/definitions/GeneralResponse" } }, "401": { @@ -1424,14 +1403,11 @@ "400": { "description": "Returns Bad Request" }, + "404": { + "description": "Returns Not Found" + }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } }, "security": [ @@ -1441,12 +1417,18 @@ ] } }, - "/api/v1/Providers/TermOfUseCancel": { - "get": { + "/api/v1/User/refresh": { + "post": { "tags": [ - "Providers" + "User" + ], + "summary": "Refresh token", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" ], - "summary": "Refuse terms of services with provider", "produces": [ "text/plain", "application/json", @@ -1454,77 +1436,51 @@ ], "parameters": [ { - "in": "query", - "name": "userId", - "type": "string", - "format": "uuid" - }, - { - "in": "query", - "name": "providerId", - "type": "string", - "format": "uuid" + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/Tokens" + } } ], "responses": { "200": { - "description": "Returns Success", + "description": "Returns Ok", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TransactionRequest" - } + "$ref": "#/definitions/Tokens" } }, - "401": { - "description": "Returns Unauthorized" - }, - "403": { - "description": "Forbidden" - }, "400": { "description": "Returns Bad Request" }, "415": { "description": "Returns Unsupported Media Type" }, - "421": { - "description": "Returns User Not Found" - }, "500": { "description": "Returns Internal Server Error" } - }, - "security": [ - { - "Bearer": [ ] - } - ] + } } }, - "/api/v1/Providers/GetStatistics": { + "/api/v1/User/get-all-requesters": { "get": { "tags": [ - "Providers" + "User" ], - "summary": "Get statistics for user", + "summary": "Get all banks", "produces": [ "text/plain", "application/json", "text/json" ], - "parameters": [ - { - "in": "query", - "name": "userId", - "type": "string" - } - ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/AllDataFromStatisticRequest" + "type": "array", + "items": { + "$ref": "#/definitions/Requester" + } } }, "400": { @@ -1535,22 +1491,16 @@ }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } } } }, - "/api/v1/Providers/GetStatisticsExtend": { - "get": { + "/api/v1/User/set-price": { + "post": { "tags": [ - "Providers" + "User" ], - "summary": "Get statistics for user extended", + "summary": "Set price for data request", "produces": [ "text/plain", "application/json", @@ -1561,793 +1511,687 @@ "in": "query", "name": "userId", "type": "string" + }, + { + "in": "query", + "name": "price", + "type": "number", + "format": "double" } ], "responses": { "200": { "description": "Returns Success", "schema": { - "$ref": "#/definitions/AllDataFromStatisticRequest" + "$ref": "#/definitions/GeneralResponse" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, - "401": { - "description": "Returns Unauthorized" + "404": { + "description": "Returns Not Found" }, "415": { "description": "Returns Unsupported Media Type" - }, - "421": { - "description": "Returns User Not Found" - }, - "500": { - "description": "Returns Internal Server Error" } - } - } - }, - "/api/v1/Providers/upload_logo": { - "post": { - "tags": [ - "Providers" - ], - "summary": "Upload logo", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" - ], - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ + }, + "security": [ { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/Uploadrequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } + "Bearer": [ ] } - } + ] } }, - "/api/v1/User/send_code/{email}": { + "/api/v1/User/get-current-price": { "get": { "tags": [ "User" ], - "summary": "User authentication by email, needs to authenticate managers", + "summary": "Get current price for data request", "produces": [ "text/plain", "application/json", "text/json" ], - "parameters": [ - { - "in": "path", - "name": "email", - "required": true, - "type": "string" - } - ], "responses": { "200": { - "description": "Returns Ok", + "description": "Returns Success", "schema": { - "$ref": "#/definitions/GeneralResponse" + "format": "double", + "type": "number" } }, + "401": { + "description": "Returns Unauthorized" + }, + "403": { + "description": "Forbidden" + }, "400": { "description": "Returns Bad Request" }, "415": { "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" } - } + }, + "security": [ + { + "Bearer": [ ] + } + ] } }, - "/api/v1/User/verify_code": { - "post": { + "/api/v1/User/generate-service-token": { + "get": { "tags": [ "User" ], - "summary": "Verify code sent by system to get JWT", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" - ], - "produces": [ - "text/plain", - "application/json", - "text/json" - ], "parameters": [ { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/VerifyCodeRequest" - } + "in": "query", + "name": "serviceName", + "type": "string" } ], "responses": { "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/refresh": { - "post": { - "tags": [ - "User" - ], - "summary": "Verify code sent by system to get JWT", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" - ], - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/Tokens" - } - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/registration/{email}": { - "post": { - "tags": [ - "User" - ], - "summary": "Registration", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "path", - "name": "email", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/verify/{email}": { - "post": { - "tags": [ - "User" - ], - "summary": "Verify", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "path", - "name": "email", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/verify": { - "post": { - "tags": [ - "User" - ], - "summary": "Verify request for user", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "query", - "name": "token", - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/list": { - "post": { - "tags": [ - "User" - ], - "summary": "List", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/User/UpToManager": { - "post": { - "tags": [ - "User" - ], - "summary": "Verify", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "query", - "name": "userId", - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/VerifyCodeResponse" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" - } - } - } - }, - "/api/v1/WebHooks/subscribe": { - "post": { - "tags": [ - "WebHooks" - ], - "summary": "Subscribe", - "consumes": [ - "application/json-patch+json", - "application/json", - "text/json", - "application/*+json" - ], - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/SubscribeRequest" - } - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } - }, - "204": { - "description": "Returns User Not Found", - "schema": { - "$ref": "#/definitions/NoContentResult" - } - }, - "400": { - "description": "Returns Bad Request", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } - }, - "415": { - "description": "Returns Unsupported Media Type", - "schema": { - "$ref": "#/definitions/UnsupportedMediaTypeResult" - } - }, - "500": { - "description": "Returns Internal Server Error", - "schema": { - "$ref": "#/definitions/GeneralResponse" - } - } - } - } - }, - "/api/v1/WebHooks/unsubscribe/{token}": { - "get": { - "tags": [ - "WebHooks" - ], - "summary": "Unsubscribe", - "produces": [ - "text/plain", - "application/json", - "text/json" - ], - "parameters": [ - { - "in": "path", - "name": "token", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns Ok", - "schema": { - "$ref": "#/definitions/Profile" - } - }, - "400": { - "description": "Returns Bad Request" - }, - "415": { - "description": "Returns Unsupported Media Type" - }, - "500": { - "description": "Returns Internal Server Error" + "description": "OK" } } } } }, "definitions": { - "AllDataFromStatisticRequest": { + "Application": { "type": "object", "properties": { - "totalEarneds": { - "type": "array", - "items": { - "$ref": "#/definitions/TotalEarned" - } + "id": { + "format": "uuid", + "type": "string" + }, + "applicationNumber": { + "type": "string" + }, + "inn": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "duration": { + "format": "int32", + "type": "integer" }, - "totalTransactions": { + "frontImage": { + "type": "string" + }, + "backImage": { + "type": "string" + }, + "faceImage": { + "type": "string" + }, + "categoryType": { "type": "array", "items": { - "$ref": "#/definitions/TransactionRequest" + "type": "string" } + }, + "requesterId": { + "format": "uuid", + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "providedAt": { + "format": "date-time", + "type": "string" + }, + "revokedAt": { + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + }, + "documentProvide": { + "type": "string" + }, + "documentRevoke": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "revokedBy": { + "type": "string" + }, + "employeeName": { + "type": "string" + }, + "employeePosition": { + "type": "string" + }, + "isAllowed": { + "type": "boolean" } - } + }, + "additionalProperties": false }, - "BasicData": { + "ApplicationDto": { "type": "object", "properties": { - "interests": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "format": "uuid", + "type": "string" }, - "languages": { - "type": "array", - "items": { - "type": "string" - } + "applicationNumber": { + "type": "string" + }, + "inn": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "duration": { + "format": "int32", + "type": "integer" + }, + "frontImage": { + "type": "string" }, - "religionViews": { + "backImage": { + "type": "string" + }, + "faceImage": { + "type": "string" + }, + "categoryType": { "type": "array", "items": { "type": "string" } }, - "politicalViews": { + "requesterId": { + "format": "uuid", + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "providedAt": { + "format": "date-time", + "type": "string" + }, + "revokedAt": { + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "revokedBy": { + "type": "string" + }, + "employeeName": { + "type": "string" + }, + "employeePosition": { + "type": "string" + }, + "isAllowed": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "ApplicationPageModel": { + "type": "object", + "properties": { + "page": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + }, + "totalItems": { + "format": "int32", + "type": "integer" + }, + "totalPages": { + "format": "int32", + "type": "integer" + }, + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/Application" } } - } + }, + "additionalProperties": false }, - "BridgeUser": { + "CategoryRequestCount": { "type": "object", "properties": { - "id": { - "format": "uuid", + "categoryType": { "type": "string" }, + "requestCount": { + "format": "int32", + "type": "integer" + } + }, + "additionalProperties": false + }, + "ChangePasswordRequest": { + "type": "object", + "properties": { "email": { "type": "string" }, - "role": { - "$ref": "#/definitions/Roles" + "oldPassword": { + "type": "string" }, - "verificationCode": { + "newPassword": { "type": "string" }, - "isVerified": { - "$ref": "#/definitions/VerifiedEnum" + "confirmPassword": { + "type": "string" + } + }, + "additionalProperties": false + }, + "ChangeStatusRequest": { + "type": "object", + "properties": { + "applicationNumber": { + "type": "string" }, - "tokenForService": { + "documentProvide": { "type": "string" }, - "createdAt": { - "format": "date-time", + "documentRevoke": { + "type": "string" + }, + "status": { + "type": "string" + }, + "passport1": { + "type": "string" + }, + "passport2": { "type": "string" }, - "secret": { - "type": "string", - "readOnly": true + "photo": { + "type": "string" } - } + }, + "additionalProperties": false }, - "Contacts": { + "CreateApplicationRequest": { "type": "object", "properties": { - "mobilePhone": { + "inn": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { "type": "string" }, - "address": { + "duration": { + "format": "int32", + "type": "integer" + }, + "phoneNumber": { "type": "string" }, - "linkedAccounts": { + "categoryType": { "type": "array", "items": { "type": "string" } + } + }, + "additionalProperties": false + }, + "GeneralResponse": { + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "The HTTP Status Code", + "type": "integer", + "example": 200 + }, + "message": { + "description": "The Message from response" + } + }, + "additionalProperties": false + }, + "GetDetailRequestByBank": { + "type": "object", + "properties": { + "bankName": { + "type": "string" + }, + "pin": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "statusOfRequest": { + "type": "string" }, - "website": { + "methodOfRequest": { "type": "string" } - } + }, + "additionalProperties": false }, - "Country": { - "required": [ - "countryCode", - "countryName" - ], + "GetDetailRequestByBankPageModel": { "type": "object", "properties": { - "countryName": { - "description": "Country name\r\nRussia", - "minLength": 1, + "page": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + }, + "totalItems": { + "format": "int32", + "type": "integer" + }, + "totalPages": { + "format": "int32", + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GetDetailRequestByBank" + } + } + }, + "additionalProperties": false + }, + "GetRequestByBankModel": { + "type": "object", + "properties": { + "bankName": { "type": "string" }, - "countryCode": { - "description": "Country code by ISO\r\nRUS", - "minLength": 1, + "bankInn": { + "type": "string" + }, + "tundukIdentifier": { + "type": "string" + }, + "fromDate": { "type": "string" }, - "phoneCode": { - "description": "Country phone code by ISO\r\n+996", + "toDate": { "type": "string" }, - "dataProviders": { + "categoryRequests": { "type": "array", "items": { - "$ref": "#/definitions/DataProvider" + "$ref": "#/definitions/CategoryRequestCount" } } - } + }, + "additionalProperties": false }, - "CountryRequest": { + "GetRequestSummary": { "type": "object", "properties": { - "id": { - "format": "uuid", + "requesterName": { "type": "string" }, - "countryName": { + "totalRequests": { + "format": "int32", + "type": "integer" + }, + "totalAmount": { + "format": "double", + "type": "number" + } + }, + "additionalProperties": false + }, + "GetRequestSummaryPageModelRequest": { + "type": "object", + "properties": { + "page": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + }, + "totalItems": { + "format": "int32", + "type": "integer" + }, + "totalPages": { + "format": "int32", + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GetRequestSummary" + } + }, + "totalAmount": { + "format": "double", + "type": "number" + } + }, + "additionalProperties": false + }, + "ImageData": { + "type": "object", + "properties": { + "imageName": { "type": "string" }, - "countryCode": { + "imageExtension": { "type": "string" }, - "phoneCode": { + "imageBase64": { "type": "string" } - } + }, + "additionalProperties": false }, - "DataProvider": { - "description": "It is assumed that if one provider is present in more than one country,\r\nthen another provider should be created for each country.", - "required": [ - "name" - ], + "KycRequestModel": { + "type": "object", + "properties": { + "imageFront": { + "$ref": "#/definitions/ImageData" + }, + "imageBack": { + "$ref": "#/definitions/ImageData" + }, + "imageFace": { + "$ref": "#/definitions/ImageData" + } + }, + "additionalProperties": false + }, + "Request": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string" }, - "name": { - "minLength": 1, + "applicationNumber": { "type": "string" }, - "bridgeUser": { - "$ref": "#/definitions/BridgeUser" + "requesterName": { + "type": "string" }, - "bridgeUserId": { - "format": "uuid", + "requesterPin": { "type": "string" }, - "icon": { + "memberCode": { "type": "string" }, - "address": { + "subsystemCode": { "type": "string" }, - "phone": { + "requesterType": { "type": "string" }, - "email": { + "pin": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, - "rewardCategories": { - "type": "array", - "items": { - "$ref": "#/definitions/RewardCategory" - } - }, - "countries": { - "type": "array", - "items": { - "$ref": "#/definitions/Country" - } + "categoryType": { + "type": "string" + }, + "response": { + "format": "int32", + "type": "integer" } - } + }, + "additionalProperties": false }, - "DataProviderRequest": { + "RequestDataModel": { "type": "object", "properties": { - "id": { - "format": "uuid", + "pin": { "type": "string" }, - "name": { + "applicationNumber": { "type": "string" }, - "icon": { + "requestOrg": { "type": "string" }, - "address": { + "requestPerson": { "type": "string" }, - "phone": { + "categoryType": { "type": "string" }, - "email": { + "memberCode": { "type": "string" }, - "bridgeUserId": { + "subsystemCode": { + "type": "string" + } + }, + "additionalProperties": false + }, + "Requester": { + "type": "object", + "properties": { + "id": { + "format": "uuid", "type": "string" }, - "token": { + "name": { + "type": "string" + }, + "requesterPin": { "type": "string" }, - "connected": { + "isActive": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, - "rewardCategories": { - "type": "array", - "items": { - "$ref": "#/definitions/RewardCategoryRequest" - } + "requesterType": { + "$ref": "#/definitions/RequesterType" }, - "countries": { + "users": { "type": "array", "items": { - "$ref": "#/definitions/CountryRequest" + "$ref": "#/definitions/User" } - }, - "verificationCode": { - "type": "string" - }, - "isVerified": { - "$ref": "#/definitions/VerifiedEnum" - }, - "bridgeUserEmail": { - "type": "string" - } - } - }, - "GeneralResponse": { - "type": "object", - "properties": { - "code": { - "format": "int32", - "description": "The HTTP Status Code", - "type": "integer", - "example": 200 - }, - "message": { - "description": "The Message from response" } - } + }, + "additionalProperties": false }, - "NoContentResult": { - "type": "object", - "properties": { - "statusCode": { - "format": "int32", - "type": "integer" - } - } + "RequesterType": { + "format": "int32", + "enum": [ + 0, + 1 + ], + "type": "integer" }, - "PersonalInterests": { + "ResetPasswordRequest": { "type": "object", "properties": { - "breifDescription": { + "email": { "type": "string" }, - "hobby": { - "type": "array", - "items": { - "type": "string" - } + "newPassword": { + "type": "string" }, - "sport": { - "type": "array", - "items": { - "type": "string" - } + "confirmPassword": { + "type": "string" } - } + }, + "additionalProperties": false }, - "PlaceOfResidence": { + "Tokens": { "type": "object", "properties": { - "currentCity": { + "access_Token": { "type": "string" }, - "birthPlace": { + "refresh_Token": { "type": "string" - }, - "otherCities": { - "type": "array", - "items": { - "type": "string" - } } - } + }, + "additionalProperties": false }, - "Profile": { + "UpdateApplicationRequest": { "type": "object", "properties": { "firstName": { @@ -2356,252 +2200,161 @@ "lastName": { "type": "string" }, - "dateOfBirth": { - "format": "date-time", + "phoneNumber": { "type": "string" }, - "gender": { + "duration": { "format": "int32", "type": "integer" }, - "email": { - "type": "array", - "items": { - "type": "string" - } - }, - "phone": { + "categoryType": { "type": "array", "items": { "type": "string" } - }, - "basicData": { - "$ref": "#/definitions/BasicData" - }, - "contacts": { - "$ref": "#/definitions/Contacts" - }, - "workAndEducation": { - "$ref": "#/definitions/WorkAndEducation" - }, - "placeOfResidence": { - "$ref": "#/definitions/PlaceOfResidence" - }, - "personalInterests": { - "$ref": "#/definitions/PersonalInterests" } - } + }, + "additionalProperties": false }, - "RewardCategory": { - "required": [ - "name" - ], + "User": { "type": "object", "properties": { "id": { "format": "uuid", - "description": "Unique identifier of reward category\r\ne12318b4-dbc7-4d18-87c2-100bed209dce", "type": "string" }, - "name": { - "description": "Enum of reward category\r\nClick", - "minLength": 1, + "firstName": { "type": "string" }, - "description": { - "description": "Description of reward category\r\nReward description", + "lastName": { "type": "string" - } - } - }, - "RewardCategoryRequest": { - "type": "object", - "properties": { - "id": { - "format": "uuid", + }, + "position": { "type": "string" }, - "name": { + "organizationName": { "type": "string" }, - "description": { + "email": { "type": "string" - } - } - }, - "Roles": { - "format": "int32", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "SubscribeRequest": { - "required": [ - "token", - "url" - ], - "type": "object", - "properties": { - "token": { - "description": "Access Token from adminpanel\r\n$2a$11$345F#lBpXelQlWknng4JGeU4c.UnjEZii#%$g#wMnLwvAey.dd", - "minLength": 1, + }, + "password": { "type": "string" }, - "url": { - "format": "uri", - "description": "URL of your service which will return personal data\r\nhttps://yourwebsite/api/v1/pd_request", - "minLength": 1, + "createdAt": { + "format": "date-time", "type": "string" - } - } - }, - "TermOfUseRequest": { - "type": "object", - "properties": { - "userId": { - "format": "uuid", + }, + "token": { "type": "string" }, - "provaiderId": { - "format": "uuid", + "isVerified": { + "type": "boolean" + }, + "role": { "type": "string" }, - "email": { - "type": "array", - "items": { - "type": "string" - } + "verificationCode": { + "type": "string" }, - "phone": { + "requesters": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/Requester" } } - } + }, + "additionalProperties": false }, - "Tokens": { + "UserRegistrationRequest": { + "required": [ + "code", + "email", + "firstName", + "lastName", + "organizationName", + "password", + "position" + ], "type": "object", "properties": { - "access_Token": { + "firstName": { + "minLength": 1, "type": "string" }, - "refresh_Token": { - "type": "string" - } - } - }, - "TotalEarned": { - "type": "object", - "properties": { - "name": { + "lastName": { + "minLength": 1, "type": "string" }, - "amount": { - "format": "double", - "type": "number" - } - } - }, - "TransactionProviderRequest": { - "type": "object", - "properties": { - "emailPhone": { + "password": { + "minLength": 1, "type": "string" }, - "rewardCategoryId": { + "email": { + "format": "email", + "minLength": 1, "type": "string" }, - "count": { - "format": "double", - "type": "number" - } - } - }, - "TransactionProviderResponse": { - "type": "object", - "properties": { - "emailPhone": { + "code": { + "minLength": 1, "type": "string" }, - "rewardCategoryName": { + "organizationName": { + "minLength": 1, "type": "string" }, - "count": { - "format": "double", - "type": "number" - }, - "usdmcdAmount": { - "format": "double", - "type": "number" - }, - "created": { - "format": "date-time", + "position": { + "minLength": 1, "type": "string" } - } + }, + "additionalProperties": false }, - "TransactionRequest": { + "UserResponse": { "type": "object", "properties": { - "txId": { + "code": { + "format": "int32", + "type": "integer" + }, + "userId": { "format": "uuid", "type": "string" }, - "from": { + "message": { }, + "email": { "type": "string" }, - "to": { + "firstName": { "type": "string" }, - "amount": { - "format": "double", - "type": "number" + "lastName": { + "type": "string" }, - "txDate": { - "format": "date-time", + "organizationName": { "type": "string" }, - "type": { + "position": { "type": "string" - } - } - }, - "UnsupportedMediaTypeResult": { - "type": "object", - "properties": { - "statusCode": { - "format": "int32", - "type": "integer" - } - } - }, - "Uploadrequest": { - "type": "object", - "properties": { - "token": { + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "isVerified": { + "type": "boolean" + }, + "accessToken": { "type": "string" }, - "imageData": { + "refreshToken": { "type": "string" }, - "extension": { + "role": { "type": "string" } - } - }, - "VerifiedEnum": { - "format": "int32", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" + }, + "additionalProperties": false }, "VerifyCodeRequest": { "type": "object", @@ -2612,7 +2365,8 @@ "code": { "type": "string" } - } + }, + "additionalProperties": false }, "VerifyCodeResponse": { "type": "object", @@ -2624,42 +2378,31 @@ "format": "int32", "type": "integer" }, - "message": { - "type": "string" - }, - "role": { + "userId": { + "format": "uuid", "type": "string" }, + "message": { }, "email": { "type": "string" }, - "token": { + "firstName": { "type": "string" }, - "isVerified": { - "$ref": "#/definitions/VerifiedEnum" - } - } - }, - "WorkAndEducation": { - "type": "object", - "properties": { - "placeOfWork": { + "lastName": { "type": "string" }, - "skills": { - "type": "array", - "items": { - "type": "string" - } + "organizationName": { + "type": "string" }, - "university": { + "position": { "type": "string" }, - "faculty": { + "role": { "type": "string" } - } + }, + "additionalProperties": false } }, "securityDefinitions": { diff --git a/README.md b/README.md index 32919c3..49e9889 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ --- description: Join the personal data revolution with MyDataCoin! +icon: hand-wave --- -# πŸ‘‹ Welcome to MyDataCoin +# Welcome to MyDataCoin {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/SUMMARY.md b/SUMMARY.md index a5b87ca..b6c08fd 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,24 +1,25 @@ # Table of contents -* [πŸ‘‹ Welcome to MyDataCoin](README.md) +* [Welcome to MyDataCoin](README.md) ## Overview -* [πŸͺ™ MDC Token Distribution and Supply](overview/mdc-token-distribution-and-supply.md) -* [πŸ€– Tech Stack](overview/tech-stack.md) -* [πŸ’ How to contribute](overview/how-to-contribute/README.md) - * [πŸ†˜ By reporting bugs](overview/how-to-contribute/by-reporting-bugs.md) - * [πŸ“Ί By watching paid Ads](overview/how-to-contribute/by-watching-paid-ads.md) - * [πŸ§‘ By inviting new members](overview/how-to-contribute/inviting-members.md) +* [MDC Token Distribution and Supply](overview/mdc-token-distribution-and-supply.md) +* [Tech Stack](overview/tech-stack.md) +* [How to contribute](overview/how-to-contribute/README.md) + * [By reporting bugs](overview/how-to-contribute/by-reporting-bugs.md) + * [By watching paid Ads](overview/how-to-contribute/by-watching-paid-ads.md) + * [By inviting new members](overview/how-to-contribute/inviting-members.md) ## Product Guides -* [πŸ’° Become a Data Provider](product-guides/become-a-data-provider/README.md) - * [πŸ‘¨β€πŸ’Ό For Managers](product-guides/become-a-data-provider/for-managers.md) - * [πŸ‘¨β€πŸ’» For Developers](product-guides/become-a-data-provider/for-developers.md) -* [βš™οΈ Become a Validator](product-guides/become-a-validator.md) -* [πŸ“² Widget](product-guides/widget.md) +* [Become a Data Provider](product-guides/become-a-data-provider/README.md) + * [For Managers](product-guides/become-a-data-provider/for-managers.md) + * [For Developers](product-guides/become-a-data-provider/for-developers.md) +* [Become a Validator](product-guides/become-a-validator.md) +* [Widget](product-guides/widget.md) +* [For Data Π‘onsumers](product-guides/for-data-sonsumers.md) ## HELPFUL MATERIALS -* [⬇️ Downloads](helpful-materials/downloads.md) +* [Downloads](helpful-materials/downloads.md) diff --git a/helpful-materials/downloads.md b/helpful-materials/downloads.md index 75d5f17..88e0727 100644 --- a/helpful-materials/downloads.md +++ b/helpful-materials/downloads.md @@ -1,8 +1,9 @@ --- description: Here you can find additional files to download +icon: folder-arrow-down --- -# ⬇️ Downloads +# Downloads {% file src="../.gitbook/assets/Brandbook.pdf" %} Brandbook diff --git a/overview/how-to-contribute/README.md b/overview/how-to-contribute/README.md index c153e1c..9fc51ef 100644 --- a/overview/how-to-contribute/README.md +++ b/overview/how-to-contribute/README.md @@ -1,8 +1,9 @@ --- description: Help us grow. +icon: hand-holding-medical --- -# πŸ’ How to contribute +# How to contribute {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/overview/how-to-contribute/by-reporting-bugs.md b/overview/how-to-contribute/by-reporting-bugs.md index 17b9c55..93a0d26 100644 --- a/overview/how-to-contribute/by-reporting-bugs.md +++ b/overview/how-to-contribute/by-reporting-bugs.md @@ -1,11 +1,12 @@ --- description: Help us to find bugs and earn DataCrystals +icon: bug --- -# πŸ†˜ By reporting bugs +# By reporting bugs {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. {% endhint %} -Found a bug? Send a screenshot with a description of the error to the Telegram group: [https://t.me/mdc\_community\_group](https://t.me/mdc\_community\_group?boost) and receive 10 DC. Your contribution is invaluable to us. +Found a bug? Send a screenshot with a description of the error to the Telegram group: [https://t.me/mdc\_community\_group](https://t.me/mdc_community_group?boost) and receive 10 DC. Your contribution is invaluable to us. diff --git a/overview/how-to-contribute/by-watching-paid-ads.md b/overview/how-to-contribute/by-watching-paid-ads.md index 14217b3..fbb4412 100644 --- a/overview/how-to-contribute/by-watching-paid-ads.md +++ b/overview/how-to-contribute/by-watching-paid-ads.md @@ -1,8 +1,9 @@ --- description: Watch paid Ads and earn DataCrystals +icon: tv-retro --- -# πŸ“Ί By watching paid Ads +# By watching paid Ads {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/overview/how-to-contribute/inviting-members.md b/overview/how-to-contribute/inviting-members.md index 6dfe797..c922061 100644 --- a/overview/how-to-contribute/inviting-members.md +++ b/overview/how-to-contribute/inviting-members.md @@ -1,8 +1,9 @@ --- description: Earn DataCrystals by inviting new members +icon: users --- -# πŸ§‘ By inviting new members +# By inviting new members {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/overview/mdc-token-distribution-and-supply.md b/overview/mdc-token-distribution-and-supply.md index e5432e9..84c3b38 100644 --- a/overview/mdc-token-distribution-and-supply.md +++ b/overview/mdc-token-distribution-and-supply.md @@ -1,4 +1,8 @@ -# πŸͺ™ MDC Token Distribution and Supply +--- +icon: coin-vertical +--- + +# MDC Token Distribution and Supply MDC is the native currency of the MyDataCoin blockchain, and it is necessary to participate in block production and receive rewards for users who share their data. MDC is an inflationary currency with no maximum supply cap. diff --git a/overview/tech-stack.md b/overview/tech-stack.md index 66fabb1..46ffe14 100644 --- a/overview/tech-stack.md +++ b/overview/tech-stack.md @@ -1,4 +1,8 @@ -# πŸ€– Tech Stack +--- +icon: robot +--- + +# Tech Stack {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/product-guides/become-a-data-provider/README.md b/product-guides/become-a-data-provider/README.md index dacc153..48883bc 100644 --- a/product-guides/become-a-data-provider/README.md +++ b/product-guides/become-a-data-provider/README.md @@ -1,4 +1,8 @@ -# πŸ’° Become a Data Provider +--- +icon: sack-dollar +--- + +# Become a Data Provider {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/product-guides/become-a-data-provider/for-developers.md b/product-guides/become-a-data-provider/for-developers.md index 2d08440..599a06c 100644 --- a/product-guides/become-a-data-provider/for-developers.md +++ b/product-guides/become-a-data-provider/for-developers.md @@ -2,9 +2,10 @@ description: >- In this guide, we provide detailed instructions for connecting a Data Holder to MyDataCoin Bridge and receiving requests. +icon: square-code --- -# πŸ‘¨β€πŸ’» For Developers +# For Developers {% hint style="warning" %} [#profile](for-developers.md#profile "mention")**Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. @@ -32,7 +33,7 @@ description: >- 64-bit kernel and CPU support for virtualization. * **Software:**\ Linux 18.04 LTS or Higher, Windows 10 or Higher\ - Docker for [Linux](https://docs.docker.com/desktop/install/linux-install/) or [Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm\_source=docker\&utm\_medium=webreferral\&utm\_campaign=dd-smartbutton\&utm\_location=module&\_gl=1\*1h1edy2\*\_ga\*MTY3NDYyODgzOC4xNjg1OTUxODU2\*\_ga\_XJWPQMJYHQ\*MTY4NzI1MzU5Ny4zLjEuMTY4NzI1MzcxMC42MC4wLjA.) + Docker for [Linux](https://docs.docker.com/desktop/install/linux-install/) or [Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm_source=docker\&utm_medium=webreferral\&utm_campaign=dd-smartbutton\&utm_location=module&_gl=1*1h1edy2*_ga*MTY3NDYyODgzOC4xNjg1OTUxODU2*_ga_XJWPQMJYHQ*MTY4NzI1MzU5Ny4zLjEuMTY4NzI1MzcxMC42MC4wLjA.) ### Overview diff --git a/product-guides/become-a-data-provider/for-managers.md b/product-guides/become-a-data-provider/for-managers.md index 888e685..ee60373 100644 --- a/product-guides/become-a-data-provider/for-managers.md +++ b/product-guides/become-a-data-provider/for-managers.md @@ -1,4 +1,8 @@ -# πŸ‘¨β€πŸ’Ό For Managers +--- +icon: user-gear +--- + +# For Managers {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/product-guides/become-a-validator.md b/product-guides/become-a-validator.md index 2317bb6..bcf0149 100644 --- a/product-guides/become-a-validator.md +++ b/product-guides/become-a-validator.md @@ -1,4 +1,8 @@ -# βš™οΈ Become a Validator +--- +icon: gear +--- + +# Become a Validator {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. diff --git a/product-guides/for-data-sonsumers.md b/product-guides/for-data-sonsumers.md new file mode 100644 index 0000000..1330996 --- /dev/null +++ b/product-guides/for-data-sonsumers.md @@ -0,0 +1,38 @@ +--- +description: >- + In this section, you will find information on how to integrate with the + service for providing legal consent for the transfer and processing of + personal data. +icon: landmark +--- + +# For Data Π‘onsumers + +{% hint style="info" %} +**Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release. +{% endhint %} + +{% hint style="danger" %} +This functionality is available only on the territory of the Kyrgyz Republic. +{% endhint %} + +Beforre you start you need to get an Authorization Token(Bearer). Please talk to our team to obtain the token. + +If you need to get a consent from user, you need to create an application first. To do that you need to make a POST request. + +{% swagger src="../.gitbook/assets/swagger.json" path="/api/v1/Application/create-application" method="post" %} +[swagger.json](../.gitbook/assets/swagger.json) +{% endswagger %} + +Once the application is created, you must wait for the user to provide their official consent. While waiting you might request status of application. + +{% swagger src="../.gitbook/assets/swagger.json" path="/api/v1/Application/get-application-by-id/{id}" method="get" %} +[swagger.json](../.gitbook/assets/swagger.json) +{% endswagger %} + +Also you can get appliction by its application number. + +{% swagger src="../.gitbook/assets/swagger.json" path="/api/v1/Application/get-application-by-application-number" method="get" %} +[swagger.json](../.gitbook/assets/swagger.json) +{% endswagger %} + diff --git a/product-guides/widget.md b/product-guides/widget.md index 668d0cd..f46cb2b 100644 --- a/product-guides/widget.md +++ b/product-guides/widget.md @@ -2,9 +2,10 @@ description: >- This section describes how you can embed the MyDataCoin functionality, as a widget, into your mobile application. +icon: mobile --- -# πŸ“² Widget +# Widget {% hint style="info" %} **Disclaimer:** The development team is working diligently, and the documentation will be updated with each new release.