diff --git a/app/src/main/resources/swagger/api-docs.json b/app/src/main/resources/swagger/api-docs.json index 7216c2c7..16a137a1 100644 --- a/app/src/main/resources/swagger/api-docs.json +++ b/app/src/main/resources/swagger/api-docs.json @@ -1566,7 +1566,7 @@ }, "BillingDataDto" : { "title" : "BillingDataDto", - "required" : [ "businessName", "digitalAddress", "recipientCode", "registeredOffice", "zipCode" ], + "required" : [ "businessName", "digitalAddress", "registeredOffice" ], "type" : "object", "properties" : { "businessName" : { diff --git a/connector/rest/docs/openapi/api-selfcare-onboarding-docs.json b/connector/rest/docs/openapi/api-selfcare-onboarding-docs.json index 08b2819c..75fc8214 100644 --- a/connector/rest/docs/openapi/api-selfcare-onboarding-docs.json +++ b/connector/rest/docs/openapi/api-selfcare-onboarding-docs.json @@ -1,1473 +1,1820 @@ { - "openapi" : "3.0.3", - "info" : { - "title" : "Onboarding API (development)", - "version" : "1.0.0" + "openapi": "3.0.3", + "info": { + "title": "onboarding-ms API", + "version": "1.0.0" }, - "paths" : { - "/v1/onboarding" : { - "get" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "The API retrieves paged onboarding using optional filter, order by descending creation date", - "parameters" : [ { - "name" : "from", - "in" : "query", - "schema" : { - "type" : "string" - } - }, { - "name" : "page", - "in" : "query", - "schema" : { - "format" : "int32", - "default" : "0", - "type" : "integer" - } - }, { - "name" : "productId", - "in" : "query", - "schema" : { - "type" : "string" - } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "format" : "int32", - "default" : "20", - "type" : "integer" - } - }, { - "name" : "status", - "in" : "query", - "schema" : { - "type" : "string" - } - }, { - "name" : "taxCode", - "in" : "query", - "schema" : { - "type" : "string" - } - }, { - "name" : "to", - "in" : "query", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingGetResponse" + "servers": [ + { + "url": "http://localhost:8080", + "description": "Auto generated value" + }, + { + "url": "http://0.0.0.0:8080", + "description": "Auto generated value" + } + ], + "paths": { + "/v1/onboarding": { + "get": { + "tags": [ + "Onboarding Controller" + ], + "summary": "The API retrieves paged onboarding using optional filter, order by descending creation date", + "parameters": [ + { + "name": "from", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "page", + "in": "query", + "schema": { + "format": "int32", + "default": "0", + "type": "integer" + } + }, + { + "name": "productId", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "query", + "schema": { + "format": "int32", + "default": "20", + "type": "integer" + } + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "taxCode", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "to", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingGetResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] }, - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform default onboarding request, it is used for GSP/SA/AS institution type.Users data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding based on institution type.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingDefaultRequest" + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform default onboarding request, it is used for GSP/SA/AS institution type.Users data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding based on institution type.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingDefaultRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/completion" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding as /onboarding but completing the onboarding request to COMPLETED phase.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingDefaultRequest" + "/v1/onboarding/completion": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding as /onboarding but completing the onboarding request to COMPLETED phase.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingDefaultRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/pa" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding request for PA institution type, it require billing.recipientCode in additition to default requestUsers data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding that consist of create contract and sending mail to institution's digital address.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingPaRequest" + "/v1/onboarding/institutionOnboardings": { + "get": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Returns onboardings record by institution taxCode/subunitCode/origin/originId", + "parameters": [ + { + "name": "origin", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "originId", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "subunitCode", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "taxCode", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OnboardingResponse" + } + } + } + } + }, + "401": { + "description": "Not Authorized" + }, + "403": { + "description": "Not Allowed" + } + }, + "security": [ + { + "SecurityScheme": [ + + ] + } + ] + } + }, + "/v1/onboarding/pa": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding request for PA institution type, it require billing.recipientCode in additition to default requestUsers data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding that consist of create contract and sending mail to institution's digital address.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingPaRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/pa/completion" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding as /onboarding/pa but completing the onboarding request to COMPLETED phase.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingPaRequest" + "/v1/onboarding/pa/completion": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding as /onboarding/pa but completing the onboarding request to COMPLETED phase.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingPaRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/pa/import" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding as /onboarding/pa but create token and completing the onboarding request to COMPLETED phase.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingImportRequest" + "/v1/onboarding/pa/import": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding as /onboarding/pa but create token and completing the onboarding request to COMPLETED phase.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingImportRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/pg/completion" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingPgRequest" + "/v1/onboarding/pg/completion": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingPgRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/psp" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding request for PSP institution type.Users data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding that consist of sending mail to Selfcare admin for approve request.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingPspRequest" + "/v1/onboarding/psp": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding request for PSP institution type.Users data will be saved on personal data vault if it doesn't already exist.At the end, function triggers async activities related to onboarding that consist of sending mail to Selfcare admin for approve request.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingPspRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/psp/completion" : { - "post" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingPspRequest" + "/v1/onboarding/psp/completion": { + "post": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform onboarding as /onboarding/psp but completing the onboarding request to COMPLETED phase.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingPspRequest" } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingResponse" + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingResponse" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}" : { - "get" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Retrieve an onboarding record given its ID", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingGet" + "/v1/onboarding/{onboardingId}": { + "get": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Retrieve an onboarding record given its ID", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingGet" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/approve" : { - "put" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform approve operation of an onboarding request receiving onboarding id.Function triggers async activities related to onboarding based on institution type or completing onboarding. ", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { } + "/v1/onboarding/{onboardingId}/approve": { + "put": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform approve operation of an onboarding request receiving onboarding id.Function triggers async activities related to onboarding based on institution type or completing onboarding. ", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/complete" : { - "put" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution.It checks the contract's signature and upload the contract on an azure storageAt the end, function triggers async activities related to complete onboarding that consist of create the institution, activate the onboarding and sending data to notification queue.", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "multipart/form-data" : { - "schema" : { - "type" : "object", - "properties" : { - "contract" : { - "format" : "binary", - "type" : "string" + "/v1/onboarding/{onboardingId}/complete": { + "put": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution.It checks the contract's signature and upload the contract on an azure storageAt the end, function triggers async activities related to complete onboarding that consist of create the institution, activate the onboarding and sending data to notification queue.", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "contract" + ], + "type": "object", + "properties": { + "contract": { + "format": "binary", + "type": "string" } } } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { } + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/consume" : { - "put" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "multipart/form-data" : { - "schema" : { - "type" : "object", - "properties" : { - "contract" : { - "format" : "binary", - "type" : "string" + "/v1/onboarding/{onboardingId}/consume": { + "put": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "contract" + ], + "type": "object", + "properties": { + "contract": { + "format": "binary", + "type": "string" } } } } } }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { } + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/pending" : { - "get" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Returns an onboarding record by its ID only if its status is PENDING. This feature is crucial for ensuring that the onboarding process can be completed only when the onboarding status is appropriately set to PENDING.", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingGet" + "/v1/onboarding/{onboardingId}/pending": { + "get": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Returns an onboarding record by its ID only if its status is PENDING. This feature is crucial for ensuring that the onboarding process can be completed only when the onboarding status is appropriately set to PENDING.", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingGet" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/reject" : { - "put" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Perform reject operation of an onboarding request receiving onboarding id.Function change status to REJECT for an onboarding request that is not COMPLETED. ", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { } + "/v1/onboarding/{onboardingId}/reject": { + "put": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Perform reject operation of an onboarding request receiving onboarding id.Function change status to REJECT for an onboarding request that is not COMPLETED. ", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReasonRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/onboarding/{onboardingId}/withUserInfo" : { - "get" : { - "tags" : [ "Onboarding Controller" ], - "summary" : "Retrieve an onboarding record given its ID adding to user sensitive information", - "parameters" : [ { - "name" : "onboardingId", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OnboardingGet" + "/v1/onboarding/{onboardingId}/withUserInfo": { + "get": { + "tags": [ + "Onboarding Controller" + ], + "summary": "Retrieve an onboarding record given its ID adding to user sensitive information", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingGet" } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } }, - "/v1/tokens" : { - "get" : { - "tags" : [ "Token Controller" ], - "summary" : "Retrieves the token for a given onboarding", - "parameters" : [ { - "name" : "onboardingId", - "in" : "query", - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TokenResponse" + "/v1/tokens": { + "get": { + "tags": [ + "Token Controller" + ], + "summary": "Retrieves the token for a given onboarding", + "parameters": [ + { + "name": "onboardingId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TokenResponse" } } } } }, - "403" : { - "description" : "Not Allowed" + "401": { + "description": "Not Authorized" + }, + "403": { + "description": "Not Allowed" + } + }, + "security": [ + { + "SecurityScheme": [ + + ] + } + ] + } + }, + "/v1/tokens/{onboardingId}/contract": { + "get": { + "tags": [ + "Token Controller" + ], + "summary": "Retrieve contract not signed for a given onboarding", + "parameters": [ + { + "name": "onboardingId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + } + }, + "401": { + "description": "Not Authorized" }, - "401" : { - "description" : "Not Authorized" + "403": { + "description": "Not Allowed" } }, - "security" : [ { - "SecurityScheme" : [ ] - } ] + "security": [ + { + "SecurityScheme": [ + + ] + } + ] } } }, - "components" : { - "schemas" : { - "AdditionalInformationsDto" : { - "type" : "object", - "properties" : { - "belongRegulatedMarket" : { - "type" : "boolean" + "components": { + "schemas": { + "AdditionalInformationsDto": { + "type": "object", + "properties": { + "belongRegulatedMarket": { + "type": "boolean" }, - "regulatedMarketNote" : { - "type" : "string" + "regulatedMarketNote": { + "type": "string" }, - "ipa" : { - "type" : "boolean" + "ipa": { + "type": "boolean" }, - "ipaCode" : { - "type" : "string" + "ipaCode": { + "type": "string" }, - "establishedByRegulatoryProvision" : { - "type" : "boolean" + "establishedByRegulatoryProvision": { + "type": "boolean" }, - "establishedByRegulatoryProvisionNote" : { - "type" : "string" + "establishedByRegulatoryProvisionNote": { + "type": "string" }, - "agentOfPublicService" : { - "type" : "boolean" + "agentOfPublicService": { + "type": "boolean" }, - "agentOfPublicServiceNote" : { - "type" : "string" + "agentOfPublicServiceNote": { + "type": "string" }, - "otherNote" : { - "type" : "string" + "otherNote": { + "type": "string" } } }, - "BillingPaRequest" : { - "required" : [ "vatNumber" ], - "type" : "object", - "properties" : { - "vatNumber" : { - "minLength" : 1, - "type" : "string" + "BillingPaRequest": { + "type": "object", + "properties": { + "vatNumber": { + "type": "string" }, - "recipientCode" : { - "type" : "string" + "recipientCode": { + "type": "string" }, - "publicServices" : { - "type" : "boolean" + "publicServices": { + "type": "boolean" } } }, - "BillingRequest" : { - "required" : [ "vatNumber" ], - "type" : "object", - "properties" : { - "vatNumber" : { - "minLength" : 1, - "type" : "string" + "BillingRequest": { + "type": "object", + "properties": { + "vatNumber": { + "type": "string" }, - "recipientCode" : { - "type" : "string" + "recipientCode": { + "type": "string" }, - "publicServices" : { - "type" : "boolean" + "publicServices": { + "type": "boolean" } } }, - "BillingResponse" : { - "type" : "object", - "properties" : { - "vatNumber" : { - "type" : "string" + "BillingResponse": { + "type": "object", + "properties": { + "vatNumber": { + "type": "string" }, - "recipientCode" : { - "type" : "string" + "recipientCode": { + "type": "string" }, - "publicServices" : { - "type" : "boolean" + "publicServices": { + "type": "boolean" } } }, - "DataProtectionOfficerRequest" : { - "type" : "object", - "properties" : { - "address" : { - "type" : "string" + "DataProtectionOfficerRequest": { + "type": "object", + "properties": { + "address": { + "type": "string" }, - "email" : { - "type" : "string" + "email": { + "type": "string" }, - "pec" : { - "type" : "string" + "pec": { + "type": "string" } } }, - "GeographicTaxonomyDto" : { - "type" : "object", - "properties" : { - "code" : { - "type" : "string" + "GeographicTaxonomyDto": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "desc" : { - "type" : "string" + "desc": { + "type": "string" } } }, - "InstitutionBaseRequest" : { - "required" : [ "institutionType", "taxCode", "digitalAddress" ], - "type" : "object", - "properties" : { - "institutionType" : { - "$ref" : "#/components/schemas/InstitutionType" + "InstitutionBaseRequest": { + "required": [ + "institutionType", + "digitalAddress" + ], + "type": "object", + "properties": { + "institutionType": { + "$ref": "#/components/schemas/InstitutionType" }, - "taxCode" : { - "minLength" : 1, - "type" : "string" + "taxCode": { + "type": "string" }, - "subunitCode" : { - "type" : "string" + "subunitCode": { + "type": "string" }, - "subunitType" : { - "$ref" : "#/components/schemas/InstitutionPaSubunitType" + "subunitType": { + "$ref": "#/components/schemas/InstitutionPaSubunitType" }, - "origin" : { - "$ref" : "#/components/schemas/Origin" + "origin": { + "$ref": "#/components/schemas/Origin" }, - "city" : { - "type" : "string" + "originId": { + "type": "string" }, - "country" : { - "type" : "string" + "city": { + "type": "string" }, - "county" : { - "type" : "string" + "country": { + "type": "string" }, - "description" : { - "type" : "string" + "county": { + "type": "string" }, - "digitalAddress" : { - "minLength" : 1, - "type" : "string" + "description": { + "type": "string" }, - "address" : { - "type" : "string" + "digitalAddress": { + "minLength": 1, + "type": "string" }, - "zipCode" : { - "type" : "string" + "address": { + "type": "string" }, - "geographicTaxonomies" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GeographicTaxonomyDto" + "zipCode": { + "type": "string" + }, + "geographicTaxonomies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicTaxonomyDto" } }, - "rea" : { - "type" : "string" + "rea": { + "type": "string" }, - "shareCapital" : { - "type" : "string" + "shareCapital": { + "type": "string" }, - "businessRegisterPlace" : { - "type" : "string" + "businessRegisterPlace": { + "type": "string" }, - "supportEmail" : { - "type" : "string" + "supportEmail": { + "type": "string" }, - "supportPhone" : { - "type" : "string" + "supportPhone": { + "type": "string" }, - "imported" : { - "type" : "boolean" + "imported": { + "type": "boolean" } } }, - "InstitutionImportRequest" : { - "required" : [ "taxCode" ], - "type" : "object", - "properties" : { - "institutionType" : { - "$ref" : "#/components/schemas/InstitutionType" + "InstitutionImportRequest": { + "required": [ + "taxCode" + ], + "type": "object", + "properties": { + "institutionType": { + "$ref": "#/components/schemas/InstitutionType" }, - "taxCode" : { - "minLength" : 1, - "type" : "string" + "taxCode": { + "minLength": 1, + "type": "string" }, - "subunitCode" : { - "type" : "string" + "subunitCode": { + "type": "string" }, - "subunitType" : { - "$ref" : "#/components/schemas/InstitutionPaSubunitType" + "subunitType": { + "$ref": "#/components/schemas/InstitutionPaSubunitType" }, - "origin" : { - "$ref" : "#/components/schemas/Origin" + "origin": { + "$ref": "#/components/schemas/Origin" }, - "city" : { - "type" : "string" + "city": { + "type": "string" }, - "country" : { - "type" : "string" + "country": { + "type": "string" }, - "county" : { - "type" : "string" + "county": { + "type": "string" }, - "description" : { - "type" : "string" + "description": { + "type": "string" }, - "digitalAddress" : { - "type" : "string" + "digitalAddress": { + "type": "string" }, - "address" : { - "type" : "string" + "address": { + "type": "string" }, - "zipCode" : { - "type" : "string" + "zipCode": { + "type": "string" }, - "geographicTaxonomies" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GeographicTaxonomyDto" + "geographicTaxonomies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicTaxonomyDto" } }, - "rea" : { - "type" : "string" + "rea": { + "type": "string" }, - "shareCapital" : { - "type" : "string" + "shareCapital": { + "type": "string" }, - "businessRegisterPlace" : { - "type" : "string" + "businessRegisterPlace": { + "type": "string" }, - "supportEmail" : { - "type" : "string" + "supportEmail": { + "type": "string" }, - "supportPhone" : { - "type" : "string" + "supportPhone": { + "type": "string" }, - "imported" : { - "type" : "boolean" + "imported": { + "type": "boolean" } } }, - "InstitutionPaSubunitType" : { - "enum" : [ "AOO", "UO" ], - "type" : "string" + "InstitutionPaSubunitType": { + "enum": [ + "AOO", + "UO" + ], + "type": "string" }, - "InstitutionPspRequest" : { - "required" : [ "institutionType", "taxCode", "digitalAddress", "paymentServiceProvider" ], - "type" : "object", - "properties" : { - "institutionType" : { - "$ref" : "#/components/schemas/InstitutionType" + "InstitutionPspRequest": { + "required": [ + "institutionType", + "digitalAddress", + "paymentServiceProvider" + ], + "type": "object", + "properties": { + "institutionType": { + "$ref": "#/components/schemas/InstitutionType" + }, + "taxCode": { + "type": "string" }, - "taxCode" : { - "minLength" : 1, - "type" : "string" + "subunitCode": { + "type": "string" }, - "subunitCode" : { - "type" : "string" + "subunitType": { + "$ref": "#/components/schemas/InstitutionPaSubunitType" }, - "subunitType" : { - "$ref" : "#/components/schemas/InstitutionPaSubunitType" + "origin": { + "$ref": "#/components/schemas/Origin" }, - "origin" : { - "$ref" : "#/components/schemas/Origin" + "originId": { + "type": "string" }, - "city" : { - "type" : "string" + "city": { + "type": "string" }, - "country" : { - "type" : "string" + "country": { + "type": "string" }, - "county" : { - "type" : "string" + "county": { + "type": "string" }, - "description" : { - "type" : "string" + "description": { + "type": "string" }, - "digitalAddress" : { - "minLength" : 1, - "type" : "string" + "digitalAddress": { + "minLength": 1, + "type": "string" }, - "address" : { - "type" : "string" + "address": { + "type": "string" }, - "zipCode" : { - "type" : "string" + "zipCode": { + "type": "string" }, - "geographicTaxonomies" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GeographicTaxonomyDto" + "geographicTaxonomies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicTaxonomyDto" } }, - "rea" : { - "type" : "string" + "rea": { + "type": "string" }, - "shareCapital" : { - "type" : "string" + "shareCapital": { + "type": "string" }, - "businessRegisterPlace" : { - "type" : "string" + "businessRegisterPlace": { + "type": "string" }, - "supportEmail" : { - "type" : "string" + "supportEmail": { + "type": "string" }, - "supportPhone" : { - "type" : "string" + "supportPhone": { + "type": "string" }, - "imported" : { - "type" : "boolean" + "imported": { + "type": "boolean" }, - "paymentServiceProvider" : { - "$ref" : "#/components/schemas/PaymentServiceProviderRequest" + "paymentServiceProvider": { + "$ref": "#/components/schemas/PaymentServiceProviderRequest" }, - "dataProtectionOfficer" : { - "$ref" : "#/components/schemas/DataProtectionOfficerRequest" + "dataProtectionOfficer": { + "$ref": "#/components/schemas/DataProtectionOfficerRequest" } } }, - "InstitutionResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "InstitutionResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "institutionType" : { - "$ref" : "#/components/schemas/InstitutionType" + "institutionType": { + "$ref": "#/components/schemas/InstitutionType" }, - "taxCode" : { - "type" : "string" + "taxCode": { + "type": "string" }, - "subunitCode" : { - "type" : "string" + "subunitCode": { + "type": "string" }, - "subunitType" : { - "$ref" : "#/components/schemas/InstitutionPaSubunitType" + "subunitType": { + "$ref": "#/components/schemas/InstitutionPaSubunitType" }, - "origin" : { - "$ref" : "#/components/schemas/Origin" + "origin": { + "$ref": "#/components/schemas/Origin" }, - "city" : { - "type" : "string" + "city": { + "type": "string" }, - "country" : { - "type" : "string" + "country": { + "type": "string" }, - "county" : { - "type" : "string" + "county": { + "type": "string" }, - "description" : { - "type" : "string" + "description": { + "type": "string" }, - "digitalAddress" : { - "type" : "string" + "digitalAddress": { + "type": "string" }, - "address" : { - "type" : "string" + "address": { + "type": "string" }, - "zipCode" : { - "type" : "string" + "zipCode": { + "type": "string" }, - "geographicTaxonomies" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GeographicTaxonomyDto" + "geographicTaxonomies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GeographicTaxonomyDto" } }, - "rea" : { - "type" : "string" + "rea": { + "type": "string" }, - "shareCapital" : { - "type" : "string" + "shareCapital": { + "type": "string" }, - "businessRegisterPlace" : { - "type" : "string" + "businessRegisterPlace": { + "type": "string" }, - "supportEmail" : { - "type" : "string" + "supportEmail": { + "type": "string" }, - "supportPhone" : { - "type" : "string" + "supportPhone": { + "type": "string" }, - "paymentServiceProvider" : { - "$ref" : "#/components/schemas/PaymentServiceProviderRequest" + "paymentServiceProvider": { + "$ref": "#/components/schemas/PaymentServiceProviderRequest" }, - "dataProtectionOfficer" : { - "$ref" : "#/components/schemas/DataProtectionOfficerRequest" + "dataProtectionOfficer": { + "$ref": "#/components/schemas/DataProtectionOfficerRequest" } } }, - "InstitutionType" : { - "enum" : [ "PA", "PG", "GSP", "SA", "PT", "SCP", "PSP", "AS", "REC", "CON" ], - "type" : "string" + "InstitutionType": { + "enum": [ + "PA", + "PG", + "GSP", + "SA", + "PT", + "SCP", + "PSP", + "AS", + "REC", + "CON" + ], + "type": "string" }, - "LocalDateTime" : { - "format" : "date-time", - "type" : "string", - "example" : "2022-03-10T12:15:50" + "LocalDateTime": { + "format": "date-time", + "type": "string", + "example": "2022-03-10T12:15:50" }, - "OnboardingDefaultRequest" : { - "required" : [ "productId", "users", "institution", "billing" ], - "type" : "object", - "properties" : { - "productId" : { - "minLength" : 1, - "type" : "string" - }, - "users" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserRequest" + "OnboardingDefaultRequest": { + "required": [ + "productId", + "users", + "institution" + ], + "type": "object", + "properties": { + "productId": { + "minLength": 1, + "type": "string" + }, + "users": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" } }, - "pricingPlan" : { - "type" : "string" + "pricingPlan": { + "type": "string" }, - "signContract" : { - "type" : "boolean" + "signContract": { + "type": "boolean" }, - "institution" : { - "$ref" : "#/components/schemas/InstitutionBaseRequest" + "institution": { + "$ref": "#/components/schemas/InstitutionBaseRequest" }, - "billing" : { - "$ref" : "#/components/schemas/BillingRequest" + "billing": { + "$ref": "#/components/schemas/BillingRequest" }, - "additionalInformations" : { - "$ref" : "#/components/schemas/AdditionalInformationsDto" + "additionalInformations": { + "$ref": "#/components/schemas/AdditionalInformationsDto" } } }, - "OnboardingGet" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "OnboardingGet": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "productId" : { - "type" : "string" + "productId": { + "type": "string" }, - "workflowType" : { - "type" : "string" + "workflowType": { + "type": "string" }, - "institution" : { - "$ref" : "#/components/schemas/InstitutionResponse" + "institution": { + "$ref": "#/components/schemas/InstitutionResponse" }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserResponse" + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserResponse" } }, - "pricingPlan" : { - "type" : "string" + "pricingPlan": { + "type": "string" + }, + "billing": { + "$ref": "#/components/schemas/BillingResponse" }, - "billing" : { - "$ref" : "#/components/schemas/BillingResponse" + "signContract": { + "type": "boolean" }, - "signContract" : { - "type" : "boolean" + "additionalInformations": { + "$ref": "#/components/schemas/AdditionalInformationsDto" }, - "additionalInformations" : { - "$ref" : "#/components/schemas/AdditionalInformationsDto" + "createdAt": { + "$ref": "#/components/schemas/LocalDateTime" }, - "createdAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "updatedAt": { + "$ref": "#/components/schemas/LocalDateTime" }, - "updatedAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "expiringDate": { + "$ref": "#/components/schemas/LocalDateTime" }, - "expiringDate" : { - "$ref" : "#/components/schemas/LocalDateTime" + "status": { + "type": "string" }, - "status" : { - "type" : "string" + "userRequestUid": { + "type": "string" }, - "userRequestUid" : { - "type" : "string" + "reasonForReject": { + "type": "string" } } }, - "OnboardingGetResponse" : { - "type" : "object", - "properties" : { - "count" : { - "format" : "int64", - "type" : "integer" - }, - "items" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OnboardingGet" + "OnboardingGetResponse": { + "type": "object", + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OnboardingGet" } } } }, - "OnboardingImportContract" : { - "required" : [ "fileName", "filePath", "createdAt" ], - "type" : "object", - "properties" : { - "fileName" : { - "minLength" : 1, - "type" : "string" - }, - "filePath" : { - "minLength" : 1, - "type" : "string" - }, - "contractType" : { - "type" : "string" - }, - "createdAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "OnboardingImportContract": { + "required": [ + "fileName", + "filePath", + "createdAt" + ], + "type": "object", + "properties": { + "fileName": { + "minLength": 1, + "type": "string" + }, + "filePath": { + "minLength": 1, + "type": "string" + }, + "contractType": { + "type": "string" + }, + "createdAt": { + "$ref": "#/components/schemas/LocalDateTime" } } }, - "OnboardingImportRequest" : { - "required" : [ "institution", "productId", "users", "contractImported" ], - "type" : "object", - "properties" : { - "institution" : { - "$ref" : "#/components/schemas/InstitutionImportRequest" - }, - "productId" : { - "minLength" : 1, - "type" : "string" - }, - "users" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserRequest" + "OnboardingImportRequest": { + "required": [ + "institution", + "productId", + "users", + "contractImported" + ], + "type": "object", + "properties": { + "institution": { + "$ref": "#/components/schemas/InstitutionImportRequest" + }, + "productId": { + "minLength": 1, + "type": "string" + }, + "users": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" } }, - "contractImported" : { - "$ref" : "#/components/schemas/OnboardingImportContract" + "contractImported": { + "$ref": "#/components/schemas/OnboardingImportContract" } } }, - "OnboardingPaRequest" : { - "required" : [ "productId", "users", "institution", "billing" ], - "type" : "object", - "properties" : { - "productId" : { - "minLength" : 1, - "type" : "string" - }, - "users" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserRequest" + "OnboardingPaRequest": { + "required": [ + "productId", + "users", + "institution" + ], + "type": "object", + "properties": { + "productId": { + "minLength": 1, + "type": "string" + }, + "users": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" } }, - "pricingPlan" : { - "type" : "string" + "pricingPlan": { + "type": "string" }, - "signContract" : { - "type" : "boolean" + "signContract": { + "type": "boolean" }, - "institution" : { - "$ref" : "#/components/schemas/InstitutionBaseRequest" + "institution": { + "$ref": "#/components/schemas/InstitutionBaseRequest" }, - "billing" : { - "$ref" : "#/components/schemas/BillingPaRequest" + "billing": { + "$ref": "#/components/schemas/BillingPaRequest" } } }, - "OnboardingPgRequest" : { - "required" : [ "productId", "users", "taxCode", "origin", "digitalAddress" ], - "type" : "object", - "properties" : { - "productId" : { - "minLength" : 1, - "type" : "string" - }, - "institutionType" : { - "$ref" : "#/components/schemas/InstitutionType" - }, - "users" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserRequest" + "OnboardingPgRequest": { + "required": [ + "productId", + "users", + "taxCode", + "origin", + "digitalAddress" + ], + "type": "object", + "properties": { + "productId": { + "minLength": 1, + "type": "string" + }, + "institutionType": { + "$ref": "#/components/schemas/InstitutionType" + }, + "users": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" } }, - "taxCode" : { - "type" : "string" + "taxCode": { + "type": "string" }, - "businessName" : { - "type" : "string" + "businessName": { + "type": "string" }, - "origin" : { - "$ref" : "#/components/schemas/Origin" + "origin": { + "$ref": "#/components/schemas/Origin" }, - "digitalAddress" : { - "pattern" : "\\S", - "type" : "string" + "digitalAddress": { + "pattern": "\\S", + "type": "string" } } }, - "OnboardingPspRequest" : { - "required" : [ "productId", "users", "institution" ], - "type" : "object", - "properties" : { - "productId" : { - "minLength" : 1, - "type" : "string" - }, - "users" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserRequest" + "OnboardingPspRequest": { + "required": [ + "productId", + "users", + "institution" + ], + "type": "object", + "properties": { + "productId": { + "minLength": 1, + "type": "string" + }, + "users": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" } }, - "pricingPlan" : { - "type" : "string" + "pricingPlan": { + "type": "string" }, - "signContract" : { - "type" : "boolean" + "signContract": { + "type": "boolean" }, - "institution" : { - "$ref" : "#/components/schemas/InstitutionPspRequest" + "institution": { + "$ref": "#/components/schemas/InstitutionPspRequest" }, - "billing" : { - "$ref" : "#/components/schemas/BillingRequest" + "billing": { + "$ref": "#/components/schemas/BillingRequest" } } }, - "OnboardingResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "OnboardingResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "productId" : { - "type" : "string" + "productId": { + "type": "string" }, - "workflowType" : { - "type" : "string" + "workflowType": { + "type": "string" }, - "institution" : { - "$ref" : "#/components/schemas/InstitutionResponse" + "institution": { + "$ref": "#/components/schemas/InstitutionResponse" }, - "pricingPlan" : { - "type" : "string" + "pricingPlan": { + "type": "string" }, - "users" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/UserOnboardingResponse" + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserOnboardingResponse" } }, - "billing" : { - "$ref" : "#/components/schemas/BillingResponse" + "billing": { + "$ref": "#/components/schemas/BillingResponse" }, - "status" : { - "type" : "string" + "status": { + "type": "string" }, - "additionalInformations" : { - "$ref" : "#/components/schemas/AdditionalInformationsDto" + "additionalInformations": { + "$ref": "#/components/schemas/AdditionalInformationsDto" }, - "userRequestUid" : { - "type" : "string" + "userRequestUid": { + "type": "string" } } }, - "Origin" : { - "enum" : [ "MOCK", "IPA", "SELC", "ANAC", "UNKNOWN", "ADE", "INFOCAMERE", "IVASS" ], - "type" : "string" + "Origin": { + "enum": [ + "MOCK", + "IPA", + "SELC", + "ANAC", + "UNKNOWN", + "ADE", + "INFOCAMERE", + "IVASS" + ], + "type": "string" }, - "PartyRole" : { - "enum" : [ "MANAGER", "DELEGATE", "SUB_DELEGATE", "OPERATOR" ], - "type" : "string" + "PartyRole": { + "enum": [ + "MANAGER", + "DELEGATE", + "SUB_DELEGATE", + "OPERATOR" + ], + "type": "string" }, - "PaymentServiceProviderRequest" : { - "type" : "object", - "properties" : { - "abiCode" : { - "type" : "string" + "PaymentServiceProviderRequest": { + "type": "object", + "properties": { + "abiCode": { + "type": "string" }, - "businessRegisterNumber" : { - "type" : "string" + "businessRegisterNumber": { + "type": "string" }, - "legalRegisterNumber" : { - "type" : "string" + "legalRegisterNumber": { + "type": "string" }, - "legalRegisterName" : { - "type" : "string" + "legalRegisterName": { + "type": "string" }, - "vatNumberGroup" : { - "type" : "boolean" + "vatNumberGroup": { + "type": "boolean" + } + } + }, + "ReasonRequest": { + "type": "object", + "properties": { + "reasonForReject": { + "type": "string" } } }, - "TokenResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "TokenResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "type" : { - "$ref" : "#/components/schemas/TokenType" + "type": { + "$ref": "#/components/schemas/TokenType" }, - "productId" : { - "type" : "string" + "productId": { + "type": "string" }, - "checksum" : { - "type" : "string" + "checksum": { + "type": "string" }, - "contractVersion" : { - "type" : "string" + "contractVersion": { + "type": "string" }, - "contractTemplate" : { - "type" : "string" + "contractTemplate": { + "type": "string" }, - "contractSigned" : { - "type" : "string" + "contractSigned": { + "type": "string" }, - "createdAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "createdAt": { + "$ref": "#/components/schemas/LocalDateTime" }, - "updatedAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "updatedAt": { + "$ref": "#/components/schemas/LocalDateTime" }, - "closedAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "closedAt": { + "$ref": "#/components/schemas/LocalDateTime" }, - "deletedAt" : { - "$ref" : "#/components/schemas/LocalDateTime" + "deletedAt": { + "$ref": "#/components/schemas/LocalDateTime" } } }, - "TokenType" : { - "enum" : [ "INSTITUTION", "LEGALS" ], - "type" : "string" + "TokenType": { + "enum": [ + "INSTITUTION", + "LEGALS" + ], + "type": "string" }, - "UserOnboardingResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "UserOnboardingResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "role" : { - "$ref" : "#/components/schemas/PartyRole" + "role": { + "$ref": "#/components/schemas/PartyRole" }, - "productRole" : { - "type" : "string" + "productRole": { + "type": "string" }, - "userMailUuid" : { - "type" : "string" + "userMailUuid": { + "type": "string" } } }, - "UserRequest" : { - "type" : "object", - "properties" : { - "taxCode" : { - "type" : "string" + "UserRequest": { + "type": "object", + "properties": { + "taxCode": { + "type": "string" }, - "name" : { - "type" : "string" + "name": { + "type": "string" }, - "surname" : { - "type" : "string" + "surname": { + "type": "string" }, - "email" : { - "type" : "string" + "email": { + "type": "string" }, - "role" : { - "$ref" : "#/components/schemas/PartyRole" + "role": { + "$ref": "#/components/schemas/PartyRole" } } }, - "UserResponse" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" + "UserResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "taxCode" : { - "type" : "string" + "taxCode": { + "type": "string" }, - "name" : { - "type" : "string" + "name": { + "type": "string" }, - "surname" : { - "type" : "string" + "surname": { + "type": "string" }, - "email" : { - "type" : "string" + "email": { + "type": "string" }, - "role" : { - "$ref" : "#/components/schemas/PartyRole" + "role": { + "$ref": "#/components/schemas/PartyRole" }, - "productRole" : { - "type" : "string" + "productRole": { + "type": "string" } } } }, - "securitySchemes" : { - "SecurityScheme" : { - "type" : "http", - "description" : "Authentication", - "scheme" : "bearer", - "bearerFormat" : "JWT" + "securitySchemes": { + "SecurityScheme": { + "type": "http", + "description": "Authentication", + "scheme": "bearer", + "bearerFormat": "JWT" } } } diff --git a/web/src/main/java/it/pagopa/selfcare/external_api/web/model/onboarding/BillingDataDto.java b/web/src/main/java/it/pagopa/selfcare/external_api/web/model/onboarding/BillingDataDto.java index 235cea59..983a702b 100644 --- a/web/src/main/java/it/pagopa/selfcare/external_api/web/model/onboarding/BillingDataDto.java +++ b/web/src/main/java/it/pagopa/selfcare/external_api/web/model/onboarding/BillingDataDto.java @@ -24,20 +24,16 @@ public class BillingDataDto { @NotBlank private String digitalAddress; - @ApiModelProperty(value = "${swagger.external_api.institutions.model.zipCode}", required = true) - @JsonProperty(required = true) - @NotBlank + @ApiModelProperty(value = "${swagger.external_api.institutions.model.zipCode}") private String zipCode; @ApiModelProperty(value = "${swagger.external_api.institutions.model.taxCode}") - @JsonProperty(required = true) private String taxCode; @ApiModelProperty(value = "${swagger.external_api.institutions.model.vatNumber}") - @JsonProperty(required = true) private String vatNumber; - @ApiModelProperty(value = "${swagger.external_api.institutions.model.recipientCode}", required = true) + @ApiModelProperty(value = "${swagger.external_api.institutions.model.recipientCode}") private String recipientCode; @ApiModelProperty(value = "${swagger.external_api.institutions.model.publicServices}")