diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 8ea2b81..572d733 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -1286,6 +1286,120 @@ } } }, + "/legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get accepted Terms of Service document", + "description" : "Returns the accepted Terms of Service document for a legal entity.", + "x-addedInVersion" : "2", + "operationId" : "get-legalEntities-id-acceptedTermsOfServiceDocument-termsofserviceacceptancereference", + "x-sortIndex" : 4, + "x-methodName" : "getAcceptedTermsOfServiceDocument", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity. For sole proprietorship, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "name" : "termsofserviceacceptancereference", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The format of the Terms of Service document. Possible values: **JSON**, **PDF**, or **TXT**", + "name" : "termsOfServiceDocumentFormat", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetAcceptedTermsOfServiceDocumentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/businessLines" : { "get" : { "tags" : [ @@ -3925,6 +4039,34 @@ }, "type" : "object" }, + "GetAcceptedTermsOfServiceDocumentResponse" : { + "additionalProperties" : false, + "properties" : { + "document" : { + "description" : "The accepted Terms of Service document in the requested format represented as a Base64-encoded bytes array.", + "format" : "byte", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the legal entity.", + "type" : "string" + }, + "termsOfServiceAcceptanceReference" : { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "type" : "string" + }, + "termsOfServiceDocumentFormat" : { + "description" : "The format of the Terms of Service document.", + "enum" : [ + "JSON", + "PDF", + "TXT" + ], + "type" : "string" + } + }, + "type" : "object" + }, "GetPciQuestionnaireInfosResponse" : { "additionalProperties" : false, "properties" : { diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index ed09103..6152556 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -1298,6 +1298,120 @@ } } }, + "/legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get accepted Terms of Service document", + "description" : "Returns the accepted Terms of Service document for a legal entity.", + "x-addedInVersion" : "2", + "operationId" : "get-legalEntities-id-acceptedTermsOfServiceDocument-termsofserviceacceptancereference", + "x-sortIndex" : 4, + "x-methodName" : "getAcceptedTermsOfServiceDocument", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity. For sole proprietorship, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "name" : "termsofserviceacceptancereference", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The format of the Terms of Service document. Possible values: **JSON**, **PDF**, or **TXT**", + "name" : "termsOfServiceDocumentFormat", + "in" : "query", + "required" : false, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetAcceptedTermsOfServiceDocumentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/businessLines" : { "get" : { "tags" : [ @@ -4356,6 +4470,34 @@ }, "type" : "object" }, + "GetAcceptedTermsOfServiceDocumentResponse" : { + "additionalProperties" : false, + "properties" : { + "document" : { + "description" : "The accepted Terms of Service document in the requested format represented as a Base64-encoded bytes array.", + "format" : "byte", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the legal entity.", + "type" : "string" + }, + "termsOfServiceAcceptanceReference" : { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "type" : "string" + }, + "termsOfServiceDocumentFormat" : { + "description" : "The format of the Terms of Service document.", + "enum" : [ + "JSON", + "PDF", + "TXT" + ], + "type" : "string" + } + }, + "type" : "object" + }, "GetPciQuestionnaireInfosResponse" : { "additionalProperties" : false, "properties" : { diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index 074b6cc..0a411b8 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -811,6 +811,78 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}: + get: + tags: + - Terms of Service + summary: Get accepted Terms of Service document + description: Returns the accepted Terms of Service document for a legal entity. + x-addedInVersion: '2' + operationId: get-legalEntities-id-acceptedTermsOfServiceDocument-termsofserviceacceptancereference + x-sortIndex: 4 + x-methodName: getAcceptedTermsOfServiceDocument + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. For sole proprietorship, + this is the individual legal entity ID of the owner. For organizations, + this is the ID of the organization. + name: id + in: path + required: true + schema: + type: string + - description: An Adyen-generated reference for the accepted Terms of Service. + name: termsofserviceacceptancereference + in: path + required: true + schema: + type: string + - description: 'The format of the Terms of Service document. Possible values: + **JSON**, **PDF**, or **TXT**' + name: termsOfServiceDocumentFormat + in: query + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetAcceptedTermsOfServiceDocumentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/businessLines: get: tags: @@ -2699,6 +2771,28 @@ components: type: string type: array type: object + GetAcceptedTermsOfServiceDocumentResponse: + additionalProperties: false + properties: + document: + description: The accepted Terms of Service document in the requested format + represented as a Base64-encoded bytes array. + format: byte + type: string + id: + description: The unique identifier of the legal entity. + type: string + termsOfServiceAcceptanceReference: + description: An Adyen-generated reference for the accepted Terms of Service. + type: string + termsOfServiceDocumentFormat: + description: The format of the Terms of Service document. + enum: + - JSON + - PDF + - TXT + type: string + type: object GetPciQuestionnaireInfosResponse: additionalProperties: false properties: diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index c4a7e2d..5672d02 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -819,6 +819,78 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}: + get: + tags: + - Terms of Service + summary: Get accepted Terms of Service document + description: Returns the accepted Terms of Service document for a legal entity. + x-addedInVersion: '2' + operationId: get-legalEntities-id-acceptedTermsOfServiceDocument-termsofserviceacceptancereference + x-sortIndex: 4 + x-methodName: getAcceptedTermsOfServiceDocument + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. For sole proprietorship, + this is the individual legal entity ID of the owner. For organizations, + this is the ID of the organization. + name: id + in: path + required: true + schema: + type: string + - description: An Adyen-generated reference for the accepted Terms of Service. + name: termsofserviceacceptancereference + in: path + required: true + schema: + type: string + - description: 'The format of the Terms of Service document. Possible values: + **JSON**, **PDF**, or **TXT**' + name: termsOfServiceDocumentFormat + in: query + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetAcceptedTermsOfServiceDocumentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/businessLines: get: tags: @@ -3014,6 +3086,28 @@ components: type: string type: array type: object + GetAcceptedTermsOfServiceDocumentResponse: + additionalProperties: false + properties: + document: + description: The accepted Terms of Service document in the requested format + represented as a Base64-encoded bytes array. + format: byte + type: string + id: + description: The unique identifier of the legal entity. + type: string + termsOfServiceAcceptanceReference: + description: An Adyen-generated reference for the accepted Terms of Service. + type: string + termsOfServiceDocumentFormat: + description: The format of the Terms of Service document. + enum: + - JSON + - PDF + - TXT + type: string + type: object GetPciQuestionnaireInfosResponse: additionalProperties: false properties: