diff --git a/src/openapi/products/purchased_products-crud.yaml b/src/openapi/products/purchased_products-crud.yaml index 390d76e..3ab0f95 100644 --- a/src/openapi/products/purchased_products-crud.yaml +++ b/src/openapi/products/purchased_products-crud.yaml @@ -80,54 +80,150 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "purchasedProducts": - [ - { - "purchasedProductId": "45573af8-a9aa-4f7c-95f4-b1971bf2c3c6", - "productId": 12, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1", - "resourceName": - { "resourceNameId": 1, "name": "contracts" }, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114", - "resourceName": - { "resourceNameId": 2, "name": "orders" }, - "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", - }, - ], - "purchasedGboProducts": - [ - { - "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", - "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, - }, - ], - }, - ], - "href": null, - } + examples: + Empty list: + value: { "purchasedProducts": [], "href": null } + List with multiple purchased products: + value: + { + "purchasedProducts": + [ + { + "purchasedProductId": "45573af8-a9aa-4f7c-95f4-b1971bf2c3c6", + "productId": 12, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1", + "resourceName": + { + "resourceNameId": 1, + "name": "contracts", + }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114", + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": + [ + { + "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", + "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": [], + }, + { + "purchasedProductId": "599f1296-ed56-4b90-a518-5c8e917a7dd6", + "productId": 12, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1", + "resourceName": + { + "resourceNameId": 1, + "name": "contracts", + }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114", + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": + [ + { + "purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "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": [], + }, + { + "purchasedProductId": "2c97c451-3bd5-467b-8db0-fd3a04fe5bc6", + "productId": 12, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "purchasedProductResourceId": "c7900130-0637-41d7-83fe-6fe283a0a1f1", + "resourceName": + { + "resourceNameId": 1, + "name": "contracts", + }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "purchasedProductResourceId": "06dae996-cdfe-45f1-833a-720201c35114", + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "issuedVoucherId": "e1f2g3h4-i5j6-k7l8-m9n0-o1p2q3r4s5t6", + "voucherCode": "VOUCHER12345", + "voucherStatus": + { "voucherStatusId": 1, "name": "Active" }, + "voucherClaims": + [ + { + "voucherClaimId": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6", + "mandatoryCustomerDataItem": + { + "mandatoryCustomerDataItemId": 8, + "name": "PadBirthdate", + }, + "value": "1990-01-01", + }, + ], + }, + ], + }, + ], + "href": null, + } post: tags: - Purchased Product @@ -139,42 +235,117 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "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, - }, - ], - } + examples: + Create Purchased GBO Product: + value: + { + "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 Purchased TapConnet Ticket: + value: + { + "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 Issued Voucher: + value: + { + "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", + "voucherStatusId": 1, + "voucherClaims": + [ + { + "mandatoryCustomerDataItemId": 8, + "value": "1999-12-31", + }, + { + "mandatoryCustomerDataItemId": 4, + "value": "vlad.harkonnen@househarkonnen.net", + }, + ], + }, + ], + } responses: "201": description: Created @@ -206,45 +377,122 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", - "productId": 14, - "createdOn": "2024-10-04T12:34:56.000", - "lastUpdatedOn": "2024-10-04T12:34:56.000", - "purchasedProductResources": - [ - { - "resourceName": - { "resourceNameId": 1, "name": "contracts" }, - "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", - }, - { - "resourceName": - { "resourceNameId": 2, "name": "orders" }, - "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, - }, - ], - } + examples: + Get Purchased GBO Product: + value: + { + "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", + "productId": 14, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceName": + { "resourceNameId": 1, "name": "contracts" }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "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": [], + } + Get Purchased Tapconnect Ticket: + value: + { + "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", + "productId": 14, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceName": + { "resourceNameId": 1, "name": "contracts" }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": + [ + { + "purchasedTapconnectTicketId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", + "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": [], + } + Get Issued Voucher: + value: + { + "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd", + "productId": 14, + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "purchasedProductResources": + [ + { + "resourceName": + { "resourceNameId": 1, "name": "contracts" }, + "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", + }, + { + "resourceName": + { "resourceNameId": 2, "name": "orders" }, + "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", + }, + ], + "purchasedGboProducts": [], + "purchasedTapconnectTickets": [], + "issuedVouchers": + [ + { + "issuedVoucherId": "e1f2g3h4-i5j6-k7l8-m9n0-o1p2q3r4s5t6", + "voucherCode": "VOUCHER12345", + "redeemedOn": null, + "expiresOn": "2024-12-31T23:59:59.000", + "createdOn": "2024-10-04T12:34:56.000", + "lastUpdatedOn": "2024-10-04T12:34:56.000", + "createdBy": "admin", + "lastUpdatedBy": "admin", + }, + ], + } patch: tags: - Purchased Product @@ -773,7 +1021,7 @@ paths: "createdBy": "user", "lastUpdatedBy": "user", }, - ] + ], } /purchasedtapconnecttickets/{purchasedTapconnectTicketId}: parameters: @@ -801,7 +1049,6 @@ paths: "activatedAt": "2024-10-05T12:34:56.000", "cancelledAt": "2024-10-06T12:34:56.000", "lastUpdatedOn": "2024-10-05T12:34:56.000", - "lastUpdatedBy": "user", } responses: "200": @@ -841,13 +1088,10 @@ paths: "voucherStatusId": 1, "voucherClaims": [ - { - "mandatoryCustomerDataItemId": 8, - "claimValue": "1999-12-31", - }, + { "mandatoryCustomerDataItemId": 8, "value": "1999-12-31" }, { "mandatoryCustomerDataItemId": 4, - "claimValue": "vlad.harkonnen@househarkonnen.net", + "value": "vlad.harkonnen@househarkonnen.net", }, ], } @@ -859,9 +1103,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - } + { "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90" } /issuedvouchers: get: tags: @@ -899,7 +1141,7 @@ paths: required: false description: The status id of the voucher. responses: - "200": + "200": description: OK content: application/json: @@ -913,10 +1155,8 @@ paths: "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", "purchasedProductId": "058a1af7-897f-45d5-b691-9cc9161e387f", "voucherCode": "VOUCHER123", - "voucherStatus": { - "voucherStatusId": 1, - "name": "New", - }, + "voucherStatus": + { "voucherStatusId": 1, "name": "New" }, "voucherClaims": [ { @@ -925,18 +1165,19 @@ paths: "mandatoryCustomerDataItemId": 8, "customerDataItem": "padBirthDate", }, - "claimValue": "1999-12-31", + "value": "1999-12-31", }, { - "mandatoryCustomerDataItem": { + "mandatoryCustomerDataItem": + { "mandatoryCustomerDataItemId": 4, "customerDataItem": "emailAddress", }, - "claimValue": "vlad.harkonnen@househarkonnen.net", + "value": "vlad.harkonnen@househarkonnen.net", }, ], }, - ] + ], } /issuedvouchers/{issuedVoucherId}: parameters: @@ -959,10 +1200,7 @@ paths: application/json: schema: $ref: "#/components/schemas/unavailable" - example: - { - "voucherStatusId": 2, - } + example: { "voucherStatusId": 2 } responses: "200": description: OK @@ -971,9 +1209,7 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - { - "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90", - } + { "issuedVoucherId": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90" } components: securitySchemes: bearerToken: