diff --git a/src/openapi/products/purchased_products-crud.yaml b/src/openapi/products/purchased_products-crud.yaml index 8dafca3..c7558cf 100644 --- a/src/openapi/products/purchased_products-crud.yaml +++ b/src/openapi/products/purchased_products-crud.yaml @@ -1009,6 +1009,8 @@ paths: "value": "vlad.harkonnen@househarkonnen.net", }, ], + "fromInclusive": "2024-10-04T12:34:56.000", + "untilInclusive": "2025-10-04T12:34:56.000", } responses: "201": @@ -1104,6 +1106,8 @@ paths: "value": "vlad.harkonnen@househarkonnen.net", }, ], + "fromInclusive": "2024-10-04T12:34:56.000", + "untilInclusive": "2025-10-04T12:34:56.000", }, ], } @@ -1181,262 +1185,266 @@ paths: Create Single Purchased GBO Product: value: { - "purchasedProducts":[ - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", - }, - ], - "purchasedGboProducts": - [ - { - "salesTimestamp": "2024-10-04T12:34:56.000", - "refundTimestamp": "2024-10-04T12:34:56.000", - "fromInclusive": "2024-10-04T12:34:56.000", - "untilInclusive": "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, - }, - ], - "purchasedTapconnectTickets": [], - "issuedVouchers": [], - } - ] + "purchasedProducts": + [ + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": + [ + { + "salesTimestamp": "2024-10-04T12:34:56.000", + "refundTimestamp": "2024-10-04T12:34:56.000", + "fromInclusive": "2024-10-04T12:34:56.000", + "untilInclusive": "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, + }, + ], + "purchasedTapconnectTickets": [], + "issuedVouchers": [], + }, + ], } Create Single Purchased TapConnet Ticket: - value: + value: { - "purchasedProducts":[ - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", - }, - ], - "purchasedGboProducts": [], - "purchasedTapconnectTickets": - [ - { - "issuedAt": "2024-10-04T12:34:56.000", - "activatedAt": "2024-10-04T12:34:56.000", - "cancelledAt": null, - "ticketReference": "KJj43nejhbTxhr897287", - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "createdBy": "user", - "lastUpdatedBy": "user", - }, - ], - "issuedVouchers": [], - } - ] + "purchasedProducts": + [ + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": + [ + { + "issuedAt": "2024-10-04T12:34:56.000", + "activatedAt": "2024-10-04T12:34:56.000", + "cancelledAt": null, + "ticketReference": "KJj43nejhbTxhr897287", + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "user", + "lastUpdatedBy": "user", + }, + ], + "issuedVouchers": [], + }, + ], } Create Single Issued Voucher: value: { - "purchasedProducts":[ - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", - }, - ], - "purchasedGboProducts": [], - "purchasedTapconnectTickets": [], - "issuedVouchers": - [ - { - "voucherCode": "VOUCHER123", - "voucherStatusInstances": - [ - { - "voucherStatusId": 1, - "createdOn": "2024-10-04T12:34:56.000", - }, - ], - "voucherClaims": - [ - { - "mandatoryCustomerDataItemId": 8, - "value": "1999-12-31", - }, - { - "mandatoryCustomerDataItemId": 4, - "value": "vlad.harkonnen@househarkonnen.net", - }, - ], - }, - ], - } - ] + "purchasedProducts": + [ + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "voucherCode": "VOUCHER123", + "voucherStatusInstances": + [ + { + "voucherStatusId": 1, + "createdOn": "2024-10-04T12:34:56.000", + }, + ], + "voucherClaims": + [ + { + "mandatoryCustomerDataItemId": 8, + "value": "1999-12-31", + }, + { + "mandatoryCustomerDataItemId": 4, + "value": "vlad.harkonnen@househarkonnen.net", + }, + ], + }, + ], + }, + ], } Create Multiple Issued Vouchers: value: { - "purchasedProducts":[ - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", - }, - ], - "purchasedGboProducts": [], - "purchasedTapconnectTickets": [], - "issuedVouchers": - [ - { - "voucherCode": "VOUCHER123", - "voucherStatusInstances": - [ - { - "voucherStatusId": 1, - "createdOn": "2024-10-04T12:34:56.000", - }, - ], - "voucherClaims": - [ - { - "mandatoryCustomerDataItemId": 8, - "value": "1999-12-31", - }, - { - "mandatoryCustomerDataItemId": 4, - "value": "vlad.harkonnen@househarkonnen.net", - }, - ], - }, - ], - }, - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "7ce32f9b-52f0-4e80-a527-0c6184b57f52", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "02047745-f03e-4c00-8e1b-8dc5c86a786e", - }, - ], - "purchasedGboProducts": [], - "purchasedTapconnectTickets": [], - "issuedVouchers": - [ - { - "voucherCode": "VOUCHER123", - "voucherStatusInstances": - [ - { - "voucherStatusId": 1, - "createdOn": "2024-10-04T12:34:56.000", - }, - ], - "voucherClaims": - [ - { - "mandatoryCustomerDataItemId": 8, - "value": "1940-01-18", - }, - { - "mandatoryCustomerDataItemId": 4, - "value": "valdemar.hoskanner@househarkonnen.net", - }, - ], - }, - ], - }, - { - "productId": 11, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceNameId": 1, - "resourceIdentifier": "7c71ec8a-3326-451f-9464-3e36d10260e3", - }, - { - "resourceNameId": 2, - "resourceIdentifier": "73c7a805-2edf-4616-a04c-267e88e0931c", - }, - ], - "purchasedGboProducts": [], - "purchasedTapconnectTickets": [], - "issuedVouchers": - [ - { - "voucherCode": "VOUCHER123", - "voucherStatusInstances": - [ - { - "voucherStatusId": 1, - "createdOn": "2024-10-04T12:34:56.000", - }, - ], - "voucherClaims": - [ - { - "mandatoryCustomerDataItemId": 8, - "value": "2016-06-08", - }, - { - "mandatoryCustomerDataItemId": 4, - "value": "alia.artreides@housearteides.net", - }, - ], - }, - ], - } - ] + "purchasedProducts": + [ + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "voucherCode": "VOUCHER123", + "voucherStatusInstances": + [ + { + "voucherStatusId": 1, + "createdOn": "2024-10-04T12:34:56.000", + }, + ], + "voucherClaims": + [ + { + "mandatoryCustomerDataItemId": 8, + "value": "1999-12-31", + }, + { + "mandatoryCustomerDataItemId": 4, + "value": "vlad.harkonnen@househarkonnen.net", + }, + ], + }, + ], + }, + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "7ce32f9b-52f0-4e80-a527-0c6184b57f52", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "02047745-f03e-4c00-8e1b-8dc5c86a786e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "voucherCode": "VOUCHER123", + "voucherStatusInstances": + [ + { + "voucherStatusId": 1, + "createdOn": "2024-10-04T12:34:56.000", + }, + ], + "voucherClaims": + [ + { + "mandatoryCustomerDataItemId": 8, + "value": "1940-01-18", + }, + { + "mandatoryCustomerDataItemId": 4, + "value": "valdemar.hoskanner@househarkonnen.net", + }, + ], + }, + ], + }, + { + "productId": 11, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceNameId": 1, + "resourceIdentifier": "7c71ec8a-3326-451f-9464-3e36d10260e3", + }, + { + "resourceNameId": 2, + "resourceIdentifier": "73c7a805-2edf-4616-a04c-267e88e0931c", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "voucherCode": "VOUCHER123", + "voucherStatusInstances": + [ + { + "voucherStatusId": 1, + "createdOn": "2024-10-04T12:34:56.000", + }, + ], + "voucherClaims": + [ + { + "mandatoryCustomerDataItemId": 8, + "value": "2016-06-08", + }, + { + "mandatoryCustomerDataItemId": 4, + "value": "alia.artreides@housearteides.net", + }, + ], + }, + ], + }, + ], } responses: "202": @@ -1485,7 +1493,7 @@ paths: description: | Body of a batch of purchased products that was successfully created. A number of purchased products were created. - value: + value: startTime: "2025-02-14T05:32:47.067Z" status: "Finished" clientTrackingId: "08584620957189579629541919368CU00" @@ -1496,7 +1504,7 @@ paths: updated: 0 total: 13 /voucherstatusinstances/bulk: - post: + post: summary: Post voucher status instances in bulk. description: Post voucher status instances in bulk. tags: @@ -1512,35 +1520,36 @@ paths: summary: List of issued vouchers to set status to revoked description: List of issued vouchers to set status to revoked value: - { - "voucherStatusInstances":[ - { - "issuedVoucherId": "8a63552f-faf5-43f3-b22d-bebc976a8a5e", - "voucherStatusId": 4, - "createdOn": "2024-10-04T12:34:56.000" - }, - { - "issuedVoucherId": "a9ff40ec-2940-413a-9957-dfd471c4caf3", - "voucherStatusId": 4, - "createdOn": "2024-10-04T12:34:56.000" - }, - { - "issuedVoucherId": "9e7363e6-beaa-4c38-9ed6-c8afed459bd5", - "voucherStatusId": 4, - "createdOn": "2024-10-04T12:34:56.000" - }, - { - "issuedVoucherId": "9d7332d6-1949-4c20-aa99-d87096b035fa", - "voucherStatusId": 4, - "createdOn": "2024-10-04T12:34:56.000" - }, - { - "issuedVoucherId": "43ca757b-8370-4cb0-92b9-717948383d5e", - "voucherStatusId": 4, - "createdOn": "2024-10-04T12:34:56.000" - }, - ] - } + { + "voucherStatusInstances": + [ + { + "issuedVoucherId": "8a63552f-faf5-43f3-b22d-bebc976a8a5e", + "voucherStatusId": 4, + "createdOn": "2024-10-04T12:34:56.000", + }, + { + "issuedVoucherId": "a9ff40ec-2940-413a-9957-dfd471c4caf3", + "voucherStatusId": 4, + "createdOn": "2024-10-04T12:34:56.000", + }, + { + "issuedVoucherId": "9e7363e6-beaa-4c38-9ed6-c8afed459bd5", + "voucherStatusId": 4, + "createdOn": "2024-10-04T12:34:56.000", + }, + { + "issuedVoucherId": "9d7332d6-1949-4c20-aa99-d87096b035fa", + "voucherStatusId": 4, + "createdOn": "2024-10-04T12:34:56.000", + }, + { + "issuedVoucherId": "43ca757b-8370-4cb0-92b9-717948383d5e", + "voucherStatusId": 4, + "createdOn": "2024-10-04T12:34:56.000", + }, + ], + } responses: "202": description: Accepted @@ -1588,7 +1597,7 @@ paths: description: | Body of a batch of voucher status instances that was successfully created. A number of voucher status instances were created. - value: + value: startTime: "2025-02-14T05:32:47.067Z" status: "Finished" clientTrackingId: "08584620957189579629541919368CU00" @@ -1597,7 +1606,7 @@ paths: summary: created: 5 updated: 0 - total: 5 + total: 5 components: securitySchemes: bearerToken: @@ -1627,8 +1636,8 @@ components: retryAfter: type: integer example: 10 - summary: - $ref: "#/components/schemas/summaryBody" + summary: + $ref: "#/components/schemas/summaryBody" required: - startTime - status @@ -1656,7 +1665,7 @@ components: - total - updated required: - - summary + - summary rfc9457: type: object properties: