From cb6f1f6f48eb99025140e096e9652e8bcb8fa087 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 18 Nov 2024 14:05:08 +0100 Subject: [PATCH] OVPAY-1116 - Added missing fields. --- .../products/purchased_products-crud.yaml | 123 +++++++++++++++++- 1 file changed, 117 insertions(+), 6 deletions(-) diff --git a/src/openapi/products/purchased_products-crud.yaml b/src/openapi/products/purchased_products-crud.yaml index 6d11d46..4c7bd89 100644 --- a/src/openapi/products/purchased_products-crud.yaml +++ b/src/openapi/products/purchased_products-crud.yaml @@ -21,7 +21,7 @@ paths: required: false description: The technical id of the product. - in: query - name: createdBefore + name: createdOnBefore schema: type: string format: date-time @@ -29,7 +29,7 @@ paths: required: false description: The purchased product should be created before this timestamp. - in: query - name: createdAfter + name: createdOnAfter schema: type: string format: date-time @@ -37,7 +37,7 @@ paths: required: false description: The purchased product should be created after this timestamp. - in: query - name: lastUpdatedBefore + name: lastUpdatedOnBefore schema: type: string format: date-time @@ -45,7 +45,7 @@ paths: required: false description: The purchased product should be last updated before this timestamp. - in: query - name: lastUpdatedAfter + name: lastUpdatedOnAfter schema: type: string format: date-time @@ -101,12 +101,18 @@ paths: "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", "salesTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "unitilInclusive": "2024-10-04T12:34:56.000", "packageTemplateId": "30003", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "ovPayTokenId": 13, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, }, ], }, @@ -144,12 +150,18 @@ paths: { "salesTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "unitilInclusive": "2024-10-04T12:34:56.000", "packageTemplateId": "30003", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "ovPayTokenId": 13, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, }, ], } @@ -208,12 +220,18 @@ paths: { "salesTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "unitilInclusive": "2024-10-04T12:34:56.000", "packageTemplateId": "30003", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "ovPayTokenId": 13, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, }, ], } @@ -300,12 +318,18 @@ paths: { "salesTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "unitilInclusive": "2024-10-04T12:34:56.000", "packageTemplateId": "30003", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "ovPayTokenId": 13, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, } responses: "201": @@ -367,6 +391,34 @@ paths: format: date-time example: 2024-10-04T12:34:56.000 description: The purchased GBO product should be refunded after this timestamp. + - in: query + name: fromInclusiveBefore + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be valid before this timestamp. + - in: query + name: fromInclusiveAfter + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be valid after this timestamp. + - in: query + name: unitilInclusiveBefore + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be valid before this timestamp. + - in: query + name: unitilInclusiveAfter + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be valid after this timestamp. - in: query name: packageTemplateId schema: @@ -408,6 +460,46 @@ paths: type: integer example: 13 description: The id of the ov pay token. + - in: query + name: createdOnBefore + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be created before this timestamp. + - in: query + name: createdOnAfter + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be created after this timestamp. + - in: query + name: lastUpdatedOnBefore + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be updated before this timestamp. + - in: query + name: lastUpdatedOnAfter + schema: + type: string + format: date-time + example: 2024-10-04T12:34:56.000 + description: The purchased GBO product should be updated after this timestamp. + - in: query + name: createdBy + schema: + type: string + example: someuser + description: The user that created the purchased GBO product. + - in: query + name: lastUpdatedBy + schema: + type: string + example: someuser + description: The user that last updated the purchased GBO product. responses: "201": description: Created @@ -422,24 +514,36 @@ paths: "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3", "salesTimestamp": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-05T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "unitilInclusive": "2024-10-05T12:34:56.000", "packageTemplateId": "30003", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "ovPayTokenId": 13, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, }, { "purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38, "purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3", "salesTimestamp": "2024-10-05T12:34:56.000", "refundTimestamp": "2024-10-06T12:34:56.000", + "fromInclusive": "2024-10-05T12:34:56.000", + "unitilInclusive": "2024-10-06T12:34:56.000", "packageTemplateId": "30003", "xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68", "xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd", "xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3", "customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d", "ovPayTokenId": 14, + "createdOn": "2024-10-05T12:34:56.000", + "lastUpdatedOn": "2024-10-05T12:34:56.000", + "createdBy": "someuser", + "lastUpdatedBy": null, }, ] /purchasedgboproducts/{purchasedGboProductId}: @@ -463,7 +567,12 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: { "refundTimestamp": "2024-10-05T12:34:56.000" } + example: + { + "refundTimestamp": "2024-10-05T12:34:56.000", + "lastUpdatedOn": "2024-10-05T12:34:56.000", + "lastUpdatedBy": "someuser", + } responses: "201": description: Created @@ -472,7 +581,9 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd" } + { + "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", + } components: securitySchemes: bearerToken: