From 6910cf37f2c4011d5ca50fddc3ead5b541a211d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Gremaud?= Date: Fri, 11 Jul 2025 11:58:25 +0200 Subject: [PATCH] feat: add swagger.yaml --- swagger.yaml | 13046 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 13046 insertions(+) create mode 100644 swagger.yaml diff --git a/swagger.yaml b/swagger.yaml new file mode 100644 index 0000000..070798b --- /dev/null +++ b/swagger.yaml @@ -0,0 +1,13046 @@ +openapi: 3.0.3 +info: + title: PolyTicket API + version: 0.0.1 + description: |- + ## Architecture + This API follows a mostly RESTful design, with exception of the `/actions/` endpoints. + + ### Filtering, Ordering & Searching + Filtering parameters are specified per endpoint in the documentation. + + Searching is done with the `q` parameter, and the searchable fields are usually in the general description of each endpoint. + + Ordering (sorting) is done with the `o` parameter the orderable fields are usually a subset of the attributes of the resource. Any incorrectly specified ordering fields trigger a `HTTP 400` response containing `error`, `invalid_ordering` and `allowed_ordering` attributes. + + ### Error responses + __Error responses are not normalised yet, and hence this section is not yet completed.__ +paths: + /api/v2/accounting/invoices/: + get: + operationId: accounting_invoices_list + description: ViewSet for `Invoice` object + parameters: + - in: query + name: basket_id + schema: + type: number + - in: query + name: event_id + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - cancelled + - created + - resolved + description: |- + * `created` - Unpaid + * `resolved` - Resolved + * `cancelled` - Cancelled + tags: + - accounting + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInvoiceList' + description: '' + /api/v2/accounting/invoices/{id}/: + get: + operationId: accounting_invoices_retrieve + description: ViewSet for `Invoice` object + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invoice. + required: true + tags: + - accounting + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Invoice' + description: '' + /api/v2/accounting/invoices/{id}/actions/refund/: + post: + operationId: accounting_invoices_actions_refund_create + description: |- + Proceed to a refund on an invoice, verifying the status and the validity of the amount. + Calls the method `refund_payment` on the payment module. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invoice. + required: true + tags: + - accounting + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Refund' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Refund' + multipart/form-data: + schema: + $ref: '#/components/schemas/Refund' + required: true + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/common/uploaded_images/: + get: + operationId: common_uploaded_images_list + description: |- + Viewset for the UploadedImage model. Depending on the `privacy_level` of the object, the object will be retrievable without authorization, with event authorization, or with ownership authorization. + + This permission does not require IsJWTAuthenticated to be use in combination because we need to be able to access public images without any authentication. The authentication for restricted image access is performed with IsJWTAuthenticated in the permission itself. + parameters: + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - common + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedUploadedImageList' + description: '' + post: + operationId: common_uploaded_images_create + description: |- + Viewset for the UploadedImage model. Depending on the `privacy_level` of the object, the object will be retrievable without authorization, with event authorization, or with ownership authorization. + + This permission does not require IsJWTAuthenticated to be use in combination because we need to be able to access public images without any authentication. The authentication for restricted image access is performed with IsJWTAuthenticated in the permission itself. + tags: + - common + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadedImage' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UploadedImage' + multipart/form-data: + schema: + $ref: '#/components/schemas/UploadedImage' + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/UploadedImage' + description: '' + /api/v2/common/uploaded_images/{id}/: + get: + operationId: common_uploaded_images_retrieve + description: |- + Viewset for the UploadedImage model. Depending on the `privacy_level` of the object, the object will be retrievable without authorization, with event authorization, or with ownership authorization. + + This permission does not require IsJWTAuthenticated to be use in combination because we need to be able to access public images without any authentication. The authentication for restricted image access is performed with IsJWTAuthenticated in the permission itself. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this uploaded image. + required: true + tags: + - common + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UploadedImage' + description: '' + patch: + operationId: common_uploaded_images_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this uploaded image. + required: true + tags: + - common + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedUploadedImage' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedUploadedImage' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedUploadedImage' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UploadedImage' + description: '' + delete: + operationId: common_uploaded_images_destroy + description: |- + Viewset for the UploadedImage model. Depending on the `privacy_level` of the object, the object will be retrievable without authorization, with event authorization, or with ownership authorization. + + This permission does not require IsJWTAuthenticated to be use in combination because we need to be able to access public images without any authentication. The authentication for restricted image access is performed with IsJWTAuthenticated in the permission itself. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this uploaded image. + required: true + tags: + - common + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/core/api_tokens/: + get: + operationId: core_api_tokens_list + parameters: + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedApiTokenList' + description: '' + /api/v2/core/api_tokens/{id}/: + get: + operationId: core_api_tokens_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this api token. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiToken' + description: '' + /api/v2/core/api_tokens/actions/me/: + get: + operationId: core_api_tokens_actions_me_retrieve + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApiToken' + description: '' + /api/v2/core/auth/actions/password_change/: + post: + operationId: core_auth_actions_password_change_create + description: This ViewSet manages polyticket users password change. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPasswordChange' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserPasswordChange' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserPasswordChange' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordChangeSuccess' + description: '' + /api/v2/core/auth/actions/password_reset/: + post: + operationId: core_auth_actions_password_reset_create + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPasswordReset' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserPasswordReset' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserPasswordReset' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordResetSuccess' + description: '' + /api/v2/core/auth/actions/password_reset_request/: + post: + operationId: core_auth_actions_password_reset_request_create + description: Send an email with a password reset link, to be used in the `UserPasswordResetViewSet.password_reset` + action + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserPasswordResetRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserPasswordResetRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserPasswordResetRequest' + required: true + security: + - {} + responses: + '204': + description: No response body + /api/v2/core/auth/actions/register/: + post: + operationId: core_auth_actions_register_create + description: |- + Validate and create a new user with the given parameters and with an `is_active` attribute set to False. + It then sends an activation email for this to be changed in a second step. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserRegistration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserRegistration' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserRegistration' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UserRegistration' + description: '' + /api/v2/core/auth/actions/register_verify/: + post: + operationId: core_auth_actions_register_verify_create + description: This ViewSet manages polyticket users registration and email verification. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserVerification' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserVerification' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserVerification' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/VerificationSuccess' + description: '' + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/VerificationError' + description: '' + /api/v2/core/auth/login/: + post: + operationId: core_auth_login_create + description: |- + View that handles User authentication. + Returns an error for unsuccessful login or a JWT on successful login. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Login' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Login' + multipart/form-data: + schema: + $ref: '#/components/schemas/Login' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LoginResult' + description: '' + /api/v2/core/documents/: + get: + operationId: core_documents_list + parameters: + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDocumentList' + description: '' + post: + operationId: core_documents_create + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Document' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Document' + multipart/form-data: + schema: + $ref: '#/components/schemas/Document' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Document' + description: '' + /api/v2/core/documents/{id}/: + get: + operationId: core_documents_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this document. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Document' + description: '' + /api/v2/core/unitmemberships/: + get: + operationId: core_unitmemberships_list + description: This ViewSet manages unit memberships. + parameters: + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: role + schema: + type: string + enum: + - member + - owner + description: |- + * `owner` - Owner + * `member` - Member + - in: query + name: unit + schema: + type: integer + - in: query + name: user + schema: + type: integer + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedUnitMembershipList' + description: '' + post: + operationId: core_unitmemberships_create + description: This ViewSet manages unit memberships. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitMembership' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UnitMembership' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnitMembership' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/UnitMembership' + description: '' + /api/v2/core/unitmemberships/{id}/: + get: + operationId: core_unitmemberships_retrieve + description: This ViewSet manages unit memberships. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this unit membership. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UnitMembership' + description: '' + patch: + operationId: core_unitmemberships_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this unit membership. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedUnitMembership' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedUnitMembership' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedUnitMembership' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UnitMembership' + description: '' + delete: + operationId: core_unitmemberships_destroy + description: This ViewSet manages unit memberships. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this unit membership. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/core/unitmemberships/actions/create_by_email/: + post: + operationId: core_unitmemberships_actions_create_by_email_create + description: Create a unitmembership using the email of the target user + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitMemberShipCreationByEmail' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UnitMemberShipCreationByEmail' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnitMemberShipCreationByEmail' + required: true + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/core/units/: + get: + operationId: core_units_list + description: |- + This ViewSet manages units. + Delete method is not allowed. + parameters: + - in: query + name: id + schema: + type: array + items: + type: integer + description: Multiple values may be separated by commas. + explode: false + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedUnitList' + description: '' + post: + operationId: core_units_create + description: |- + This ViewSet manages units. + Delete method is not allowed. + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Unit' + multipart/form-data: + schema: + $ref: '#/components/schemas/Unit' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + description: '' + /api/v2/core/units/{id}/: + get: + operationId: core_units_retrieve + description: |- + This ViewSet manages units. + Delete method is not allowed. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this unit. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + description: '' + patch: + operationId: core_units_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this unit. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedUnit' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedUnit' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedUnit' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + description: '' + /api/v2/core/users/: + get: + operationId: core_users_list + parameters: + - in: query + name: email + schema: + type: string + - in: query + name: first_name + schema: + type: string + - in: query + name: last_name + schema: + type: string + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: units + schema: + type: array + items: + type: integer + explode: true + style: form + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPolyTicketUserList' + description: '' + post: + operationId: core_users_create + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolyTicketUser' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PolyTicketUser' + multipart/form-data: + schema: + $ref: '#/components/schemas/PolyTicketUser' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PolyTicketUser' + description: '' + /api/v2/core/users/{id}/: + get: + operationId: core_users_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this User. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolyTicketUser' + description: '' + patch: + operationId: core_users_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this User. + required: true + tags: + - core + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedPolyTicketUser' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedPolyTicketUser' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedPolyTicketUser' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolyTicketUser' + description: '' + delete: + operationId: core_users_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this User. + required: true + tags: + - core + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/events/events/: + get: + operationId: events_events_list + parameters: + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: unit + schema: + type: integer + tags: + - events + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEventList' + description: '' + post: + operationId: events_events_create + tags: + - events + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Event' + multipart/form-data: + schema: + $ref: '#/components/schemas/Event' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + description: '' + /api/v2/events/events/{id}/: + get: + operationId: events_events_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + description: '' + patch: + operationId: events_events_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedEvent' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedEvent' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedEvent' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + description: '' + delete: + operationId: events_events_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/events/events/{id}/actions/duplicate/: + post: + operationId: events_events_actions_duplicate_create + description: Duplicate an event, its active modules and all configurations + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Event' + multipart/form-data: + schema: + $ref: '#/components/schemas/Event' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + description: '' + /api/v2/events/events/{id}/actions/export/: + post: + operationId: events_events_actions_export_create + parameters: + - in: query + name: file_type + schema: + type: string + enum: + - csv + - xlsx + default: xlsx + description: Desired export file type + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + - in: query + name: testing + schema: + type: boolean + default: false + description: Whether you want the export for testing mode or not + tags: + - events + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Event' + multipart/form-data: + schema: + $ref: '#/components/schemas/Event' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + description: '' + /api/v2/events/events/{id}/actions/moderate/: + post: + operationId: events_events_actions_moderate_create + description: |- + Action from the PolyTicket team to moderate an event. + + If the event is valid: change moderation_status to validated and send an email to the organisers to notify them of the validation. + + Else: change moderation_status to change_requested and send an email to the organisers to ask for necessary changes. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EventModeration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/EventModeration' + multipart/form-data: + schema: + $ref: '#/components/schemas/EventModeration' + required: true + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/events/events/{id}/actions/node_stocks/: + get: + operationId: events_events_actions_node_stocks_list + description: This endpoint returns an overview of what has been consumed of + the event so far, and how many items remain, when applicable. Each object + of the response represents one node, with related usage information and limits + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + - in: query + name: testing + schema: + type: boolean + default: false + description: Testing mode + tags: + - events + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NodeStock' + description: '' + /api/v2/events/events/{id}/actions/request_moderation/: + post: + operationId: events_events_actions_request_moderation_create + description: Action to request moderation from the PolyTicket team on an event. + Send a mail to PolyTicket with all necessary information and change moderation_status + to requested. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + tags: + - events + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/events/events/{id}/actions/statistics/: + get: + operationId: events_events_actions_statistics_retrieve + description: |- + Get event statistics by chosen granularity. Please note that data isn't sorted in chronological order within the different dicts. + Includes all data after `interval_start`, adding a point at `interval_start` with the last known value before it (or 0 if none). + Includes all data before `interval_end`, adding a point at `interval_end` with the next available value (or the last known value if none). + parameters: + - in: query + name: granularity + schema: + type: string + enum: + - day + - five_minute + - hour + - timestamp + default: timestamp + description: Desired granularity, i.e. aggregation bucket size + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + - in: query + name: interval_end + schema: + type: string + format: date-time + description: All data points before interval_end are returned, and a data + point with the timestamp of interval_end is returned, with the earliest + value after interval_end, or the same value as the last value before interval_end, + in case no previous data points are available. + - in: query + name: interval_start + schema: + type: string + format: date-time + description: All data points after interval_start are returned, and a data + point with the timestamp of interval_start is returned, with most recent + value before interval_start, or value 0 in case no previous data points + are available) + - in: query + name: testing + schema: + type: boolean + default: false + description: Testing mode + tags: + - events + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventStatistics' + description: '' + /api/v2/events/events/{id}/actions/ticket_office_infos/: + get: + operationId: events_events_actions_ticket_office_infos_retrieve + description: Get all infos related to an Event, filtered based on Conditions + parameters: + - in: query + name: frontend_basket + schema: + type: integer + description: The FrontendBasket pk used to access the resource. + required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this event. + required: true + - in: query + name: node_selected_ids + schema: + type: array + items: + type: number + description: Optional ids of children of articles that have been selected + to update the article price + tags: + - events + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TicketOfficeInfos' + description: '' + /api/v2/events/events/actions/public_infos/{frontend_path}/: + get: + operationId: events_events_actions_public_infos_retrieve + parameters: + - in: path + name: frontend_path + schema: + type: string + pattern: ^[-a-zA-Z0-9_]+$ + required: true + - in: query + name: testing + schema: + type: boolean + description: Whether you access the event public infos in testing mode or + not. + required: true + tags: + - events + security: + - basicAuth: [] + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/EventPublicInfos' + description: '' + /api/v2/modules_auth/anonymous_login/actions/create_login/: + post: + operationId: modules_auth_anonymous_login_actions_create_login_create + description: Create an anonymous frontend login. Accessible only on public events + or in testing mode. + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAnonymousLogin' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CreateAnonymousLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateAnonymousLogin' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LoginJWT' + description: '' + /api/v2/modules_auth/anonymous_login/modules/: + get: + operationId: modules_auth_anonymous_login_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleAuthAnonymousLogin`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleAuthAnonymousLoginActiveModuleList' + description: '' + post: + operationId: modules_auth_anonymous_login_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleAuthAnonymousLogin`. + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + description: '' + /api/v2/modules_auth/anonymous_login/modules/{id}/: + get: + operationId: modules_auth_anonymous_login_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleAuthAnonymousLogin`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + description: '' + patch: + operationId: modules_auth_anonymous_login_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleAuthAnonymousLoginActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleAuthAnonymousLoginActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleAuthAnonymousLoginActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + description: '' + delete: + operationId: modules_auth_anonymous_login_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleAuthAnonymousLogin`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_auth/frontend_logins/: + get: + operationId: modules_auth_frontend_logins_list + parameters: + - in: query + name: event + schema: + type: integer + - in: query + name: id + schema: + type: array + items: + type: integer + description: Multiple values may be separated by commas. + explode: false + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: testing + schema: + type: boolean + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFrontendLoginList' + description: '' + /api/v2/modules_auth/frontend_logins/{id}/: + get: + operationId: modules_auth_frontend_logins_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend login. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendLogin' + description: '' + /api/v2/modules_auth/login_methods/: + get: + operationId: modules_auth_login_methods_list + parameters: + - in: query + name: event + schema: + type: integer + description: The Event id for which to get available login methods. + required: true + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: testing + schema: + type: boolean + description: Whether you access the login methods in testing mode or not. + required: true + tags: + - modules_auth + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedLoginMethodList' + description: '' + /api/v2/modules_auth/third_party_token_login/actions/validate_login/: + post: + operationId: modules_auth_third_party_token_login_actions_validate_login_create + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ValidateThirdPartyTokenLogin' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ValidateThirdPartyTokenLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/ValidateThirdPartyTokenLogin' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LoginJWT' + description: '' + /api/v2/modules_auth/third_party_token_login/modules/: + get: + operationId: modules_auth_third_party_token_login_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleAuthThirdPartyTokenLoginActiveModuleList' + description: '' + post: + operationId: modules_auth_third_party_token_login_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin`. + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + description: '' + /api/v2/modules_auth/third_party_token_login/modules/{id}/: + get: + operationId: modules_auth_third_party_token_login_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + description: '' + patch: + operationId: modules_auth_third_party_token_login_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleAuthThirdPartyTokenLoginActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleAuthThirdPartyTokenLoginActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleAuthThirdPartyTokenLoginActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + description: '' + delete: + operationId: modules_auth_third_party_token_login_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_auth/trusted_email/actions/create_login/: + post: + operationId: modules_auth_trusted_email_actions_create_login_create + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTrustedEmailLogin' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CreateTrustedEmailLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateTrustedEmailLogin' + required: true + security: + - {} + responses: + '204': + description: No response body + /api/v2/modules_auth/trusted_email/actions/validate_login/: + post: + operationId: modules_auth_trusted_email_actions_validate_login_create + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ValidateTrustedEmailLogin' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ValidateTrustedEmailLogin' + multipart/form-data: + schema: + $ref: '#/components/schemas/ValidateTrustedEmailLogin' + required: true + security: + - {} + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LoginJWT' + description: '' + /api/v2/modules_auth/trusted_email/modules/: + get: + operationId: modules_auth_trusted_email_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleAuthTrustedEmail`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleAuthTrustedEmailActiveModuleList' + description: '' + post: + operationId: modules_auth_trusted_email_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleAuthTrustedEmail`. + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + description: '' + /api/v2/modules_auth/trusted_email/modules/{id}/: + get: + operationId: modules_auth_trusted_email_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleAuthTrustedEmail`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + description: '' + patch: + operationId: modules_auth_trusted_email_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleAuthTrustedEmailActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleAuthTrustedEmailActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleAuthTrustedEmailActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + description: '' + delete: + operationId: modules_auth_trusted_email_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleAuthTrustedEmail`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_auth + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_basket/billing_informations/: + get: + operationId: modules_basket_billing_informations_list + parameters: + - in: query + name: basket_id + schema: + type: integer + - in: query + name: created_by + schema: + type: string + - in: query + name: event_id + schema: + type: number + - in: query + name: is_deleted + schema: + type: boolean + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: user + schema: + type: string + tags: + - modules_basket + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedBillingInformationList' + description: '' + post: + operationId: modules_basket_billing_informations_create + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BillingInformation' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/BillingInformation' + multipart/form-data: + schema: + $ref: '#/components/schemas/BillingInformation' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/BillingInformation' + description: '' + /api/v2/modules_basket/billing_informations/{id}/: + get: + operationId: modules_basket_billing_informations_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this billing information. + required: true + tags: + - modules_basket + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BillingInformation' + description: '' + /api/v2/modules_basket/frontend_baskets/: + get: + operationId: modules_basket_frontend_baskets_list + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: created_by_id + schema: + type: integer + - in: query + name: event + schema: + type: integer + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: testing + schema: + type: boolean + tags: + - modules_basket + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedFrontendBasketList' + description: '' + post: + operationId: modules_basket_frontend_baskets_create + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/FrontendBasket' + multipart/form-data: + schema: + $ref: '#/components/schemas/FrontendBasket' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + description: '' + /api/v2/modules_basket/frontend_baskets/{id}/: + get: + operationId: modules_basket_frontend_baskets_retrieve + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + tags: + - modules_basket + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + description: '' + patch: + operationId: modules_basket_frontend_baskets_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedFrontendBasket' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedFrontendBasket' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedFrontendBasket' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + description: '' + /api/v2/modules_basket/frontend_baskets/{id}/actions/add_to_basket/: + post: + operationId: modules_basket_frontend_baskets_actions_add_to_basket_create + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeCreation' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SelectedNodeCreation' + multipart/form-data: + schema: + $ref: '#/components/schemas/SelectedNodeCreation' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeCreation' + description: '' + /api/v2/modules_basket/frontend_baskets/{id}/actions/generate_ticket/: + post: + operationId: modules_basket_frontend_baskets_actions_generate_ticket_create + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/FrontendBasket' + multipart/form-data: + schema: + $ref: '#/components/schemas/FrontendBasket' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FrontendBasket' + description: '' + /api/v2/modules_basket/frontend_baskets/{id}/actions/remove_from_basket/: + post: + operationId: modules_basket_frontend_baskets_actions_remove_from_basket_create + description: |- + ViewSet of model FrontendBasket, searching is possible via the following fields: + pk, total, selectednode__pk, created_by__pk, created_by__email and created_by__username + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + tags: + - modules_basket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeDeletion' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SelectedNodeDeletion' + multipart/form-data: + schema: + $ref: '#/components/schemas/SelectedNodeDeletion' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeDeletion' + description: '' + /api/v2/modules_basket/frontend_baskets/{id}/actions/validate_extra_infos/: + get: + operationId: modules_basket_frontend_baskets_actions_validate_extra_infos_retrieve + description: Ensures that all required extra info fields have been filled. Returns + the `SelectedNodeExtraInfos` that are required but have no value, and an empty + JSON if everything is correct. + parameters: + - in: query + name: expand + schema: + type: string + description: 'Name of the fields you want to expand. Available fields: billing_information, + created_by' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this frontend basket. + required: true + - in: query + name: inline_type + schema: + type: string + enum: + - all + - inline_only + - no_inline + default: all + description: '`all` uses all SelectedNodeExtraInfo, `inline_only` only considers + inline groups, and `no_inline` only non-inlined.' + tags: + - modules_basket + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeExtraInfo' + description: '' + /api/v2/modules_completion/completion_started/: + post: + operationId: modules_completion_completion_started_create + description: |- + ViewSet to tell the backend that the customer has reached the ticket office summary page. + It will trigger hooks that, for example, send a payment reminder email. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompletionStarted' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CompletionStarted' + multipart/form-data: + schema: + $ref: '#/components/schemas/CompletionStarted' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CompletionStarted' + description: '' + /api/v2/modules_completion/confirmation_page_extra_text/modules/: + get: + operationId: modules_completion_confirmation_page_extra_text_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConfirmationPageExtraTextActiveModuleList' + description: '' + post: + operationId: modules_completion_confirmation_page_extra_text_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText`. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + description: '' + /api/v2/modules_completion/confirmation_page_extra_text/modules/{id}/: + get: + operationId: modules_completion_confirmation_page_extra_text_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + description: '' + patch: + operationId: modules_completion_confirmation_page_extra_text_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedConfirmationPageExtraTextActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedConfirmationPageExtraTextActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedConfirmationPageExtraTextActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + description: '' + delete: + operationId: modules_completion_confirmation_page_extra_text_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_completion/email_registration_completed_simple/modules/: + get: + operationId: modules_completion_email_registration_completed_simple_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleCompletionEmailRegistrationCompletedActiveModuleList' + description: '' + post: + operationId: modules_completion_email_registration_completed_simple_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted`. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + description: '' + /api/v2/modules_completion/email_registration_completed_simple/modules/{id}/: + get: + operationId: modules_completion_email_registration_completed_simple_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + description: '' + patch: + operationId: modules_completion_email_registration_completed_simple_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCompletedActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCompletedActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCompletedActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + description: '' + delete: + operationId: modules_completion_email_registration_completed_simple_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_completion/email_registration_creation/modules/: + get: + operationId: modules_completion_email_registration_creation_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleCompletionEmailRegistrationCreationActiveModuleList' + description: '' + post: + operationId: modules_completion_email_registration_creation_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation`. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + description: '' + /api/v2/modules_completion/email_registration_creation/modules/{id}/: + get: + operationId: modules_completion_email_registration_creation_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + description: '' + patch: + operationId: modules_completion_email_registration_creation_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCreationActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCreationActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionEmailRegistrationCreationActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + description: '' + delete: + operationId: modules_completion_email_registration_creation_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_completion/pdf_ticket/modules/: + get: + operationId: modules_completion_pdf_ticket_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionPDFTicket`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleCompletionPDFTicketActiveModuleList' + description: '' + post: + operationId: modules_completion_pdf_ticket_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionPDFTicket`. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + description: '' + /api/v2/modules_completion/pdf_ticket/modules/{id}/: + get: + operationId: modules_completion_pdf_ticket_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionPDFTicket`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + description: '' + patch: + operationId: modules_completion_pdf_ticket_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionPDFTicketActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionPDFTicketActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionPDFTicketActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + description: '' + delete: + operationId: modules_completion_pdf_ticket_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionPDFTicket`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_completion/redirect/modules/: + get: + operationId: modules_completion_redirect_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionRedirect`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleCompletionRedirectActiveModuleList' + description: '' + post: + operationId: modules_completion_redirect_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionRedirect`. + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + description: '' + /api/v2/modules_completion/redirect/modules/{id}/: + get: + operationId: modules_completion_redirect_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionRedirect`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + description: '' + patch: + operationId: modules_completion_redirect_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionRedirectActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionRedirectActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleCompletionRedirectActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + description: '' + delete: + operationId: modules_completion_redirect_modules_destroy + description: ViewSet of model `ActiveModule` linked to `ModuleCompletionRedirect`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_completion + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_payments/methods/: + get: + operationId: modules_payments_methods_list + description: List available payment methods for the linked basket + parameters: + - in: query + name: basket + schema: + type: integer + description: The FrontendBasket id used to access the resource. + required: true + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPaymentMethodList' + description: '' + /api/v2/modules_payments/methods/actions/start_payment/: + post: + operationId: modules_payments_methods_actions_start_payment_create + description: |- + Use this endpoint to start a payment for a given basket. + + Payments must *also* be made for free / 0-amount baskets. + + A basket has the following requirements to be able to be paid: + - Terms of Service accepted + - Billing information is specified + - Is editable (all registrations of the basket must be in ``new`` state) + + You must provide the ID of the active module of the desired payment method for a non-zero payment, otherwise you can omit this. + + This endpoint will create an Invoice and Payment Intent. In the case of a zero-payment, the basket is also directly marked as paid. + Else, if the requested payment method requires the user to continue on another website, the response will include `is_external_redirect=true`, + and you must redirect the user to the URL specified in `link`. If the attribute is false, then you must do the rest of the handling in the front end. + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentStart' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PaymentStart' + multipart/form-data: + schema: + $ref: '#/components/schemas/PaymentStart' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentStart' + description: '' + /api/v2/modules_payments/payment_intents/: + get: + operationId: modules_payments_payment_intents_list + description: API endpoint that allows PaymentIntent to be viewed. + parameters: + - in: query + name: basket_id + schema: + type: integer + - in: query + name: expand + schema: + type: string + description: 'Add the name of the fields you want to expand. Available fields: + invoice' + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPaymentIntentList' + description: '' + /api/v2/modules_payments/payment_intents/{id}/: + get: + operationId: modules_payments_payment_intents_retrieve + description: API endpoint that allows PaymentIntent to be viewed. + parameters: + - in: query + name: expand + schema: + type: string + description: 'Add the name of the fields you want to expand. Available fields: + invoice' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this payment intent. + required: true + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentIntent' + description: '' + /api/v2/modules_payments/payment_intents/{id}/actions/cancel/: + post: + operationId: modules_payments_payment_intents_actions_cancel_create + description: |- + This view action cancels a payment intent and returns an error in case the payment intent was not in a cancellable state (paid or already cancelled). + + After cancelling a payment intent, you should redirect the user to do the payment method choice and order validation again. + parameters: + - in: query + name: expand + schema: + type: string + description: 'Add the name of the fields you want to expand. Available fields: + invoice' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this payment intent. + required: true + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentIntent' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PaymentIntent' + multipart/form-data: + schema: + $ref: '#/components/schemas/PaymentIntent' + required: true + security: + - JWTAuth: [] + responses: + '204': + description: No response body + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/CancelError' + description: '' + /api/v2/modules_payments/payment_intents/{id}/actions/request_status_update/: + post: + operationId: modules_payments_payment_intents_actions_request_status_update_create + description: |- + This view action must be provided with the `status` that the frontend has received from an external PSP. Calling this endpoint will trigger an **asynchronous** process that will ensure the status of the `PaymentIntent` is coherent with its status on the external PSP. + + After having called this endpoint, you should poll the detail of the `PaymentIntent` until one of `is_error`, `is_cancelled` or `invoice.is_resolved` have changed. + parameters: + - in: query + name: expand + schema: + type: string + description: 'Add the name of the fields you want to expand. Available fields: + invoice' + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this payment intent. + required: true + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentIntentRequestUpdate' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PaymentIntentRequestUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/PaymentIntentRequestUpdate' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentIntentRequestUpdate' + description: '' + /api/v2/modules_payments/payrexx/modules/: + get: + operationId: modules_payments_payrexx_modules_list + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPayrexx`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModulePaymentPayrexxActiveModuleList' + description: '' + post: + operationId: modules_payments_payrexx_modules_create + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPayrexx`. + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + description: '' + /api/v2/modules_payments/payrexx/modules/{id}/: + get: + operationId: modules_payments_payrexx_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPayrexx`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + description: '' + patch: + operationId: modules_payments_payrexx_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPayrexxActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPayrexxActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPayrexxActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + description: '' + /api/v2/modules_payments/payrexx/webhooks/: + post: + operationId: modules_payments_payrexx_webhooks_create + description: Called by Payrexx to update status of Gateway. Will return a HTTP + 200 as soon as possible, and do any treatment of the webhook content asynchronously. + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Webhooks' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Webhooks' + multipart/form-data: + schema: + $ref: '#/components/schemas/Webhooks' + required: true + security: + - {} + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Webhooks' + description: '' + /api/v2/modules_payments/pointofsale/modules/: + get: + operationId: modules_payments_pointofsale_modules_list + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPointOfSale`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModulePaymentPointOfSaleActiveModuleList' + description: '' + post: + operationId: modules_payments_pointofsale_modules_create + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPointOfSale`. + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + description: '' + /api/v2/modules_payments/pointofsale/modules/{id}/: + get: + operationId: modules_payments_pointofsale_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModulePaymentPointOfSale`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + description: '' + patch: + operationId: modules_payments_pointofsale_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPointOfSaleActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPointOfSaleActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModulePaymentPointOfSaleActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + description: '' + /api/v2/modules_payments/pointofsale/places/: + get: + operationId: modules_payments_pointofsale_places_list + description: ViewSet for `ModulePaymentPointOfSaleConfigurationPlace` model. + parameters: + - in: query + name: event + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPointOfSalePlaceReadOnlyList' + description: '' + post: + operationId: modules_payments_pointofsale_places_create + description: ViewSet for `ModulePaymentPointOfSaleConfigurationPlace` model. + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + multipart/form-data: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + description: '' + /api/v2/modules_payments/pointofsale/places/{id}/: + get: + operationId: modules_payments_pointofsale_places_retrieve + description: ViewSet for `ModulePaymentPointOfSaleConfigurationPlace` model. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module payment point + of sale configuration place. + required: true + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + description: '' + patch: + operationId: modules_payments_pointofsale_places_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module payment point + of sale configuration place. + required: true + tags: + - modules_payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedPointOfSalePlaceReadOnly' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedPointOfSalePlaceReadOnly' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedPointOfSalePlaceReadOnly' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + description: '' + delete: + operationId: modules_payments_pointofsale_places_destroy + description: ViewSet for `ModulePaymentPointOfSaleConfigurationPlace` model. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this module payment point + of sale configuration place. + required: true + tags: + - modules_payments + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/access_management/modules/: + get: + operationId: modules_registrations_access_management_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationAccessManagement`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleRegistrationAccessManagementActiveModuleList' + description: '' + post: + operationId: modules_registrations_access_management_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationAccessManagement`. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + description: '' + /api/v2/modules_registrations/access_management/modules/{id}/: + get: + operationId: modules_registrations_access_management_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationAccessManagement`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + description: '' + patch: + operationId: modules_registrations_access_management_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationAccessManagementActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationAccessManagementActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationAccessManagementActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + description: '' + /api/v2/modules_registrations/access_management/places/: + get: + operationId: modules_registrations_access_management_places_list + description: ViewSet of model AccessManagementPlace + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedAccessManagementPlaceList' + description: '' + post: + operationId: modules_registrations_access_management_places_create + description: ViewSet of model AccessManagementPlace + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + multipart/form-data: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + description: '' + /api/v2/modules_registrations/access_management/places/{id}/: + get: + operationId: modules_registrations_access_management_places_retrieve + description: ViewSet of model AccessManagementPlace + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this access management place. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + description: '' + patch: + operationId: modules_registrations_access_management_places_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this access management place. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedAccessManagementPlace' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedAccessManagementPlace' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedAccessManagementPlace' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AccessManagementPlace' + description: '' + delete: + operationId: modules_registrations_access_management_places_destroy + description: ViewSet of model AccessManagementPlace + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this access management place. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/accesses/: + get: + operationId: modules_registrations_options_accesses_list + description: |- + This view manages accesses + It filters accesses linked to configurations, via `NodeAccessM2M` through table, which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configurations + schema: + type: array + items: + type: integer + explode: true + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeAccessList' + description: '' + post: + operationId: modules_registrations_options_accesses_create + description: |- + This view manages accesses + It filters accesses linked to configurations, via `NodeAccessM2M` through table, which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccess' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeAccess' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeAccess' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccess' + description: '' + /api/v2/modules_registrations/options/accesses/{id}/: + get: + operationId: modules_registrations_options_accesses_retrieve + description: |- + This view manages accesses + It filters accesses linked to configurations, via `NodeAccessM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node access. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccess' + description: '' + patch: + operationId: modules_registrations_options_accesses_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node access. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeAccess' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeAccess' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeAccess' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccess' + description: '' + delete: + operationId: modules_registrations_options_accesses_destroy + description: |- + This view manages accesses + It filters accesses linked to configurations, via `NodeAccessM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node access. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/accesses_m2m/: + get: + operationId: modules_registrations_options_accesses_m2m_list + description: |- + This view manages node configuration/access relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: query + name: access + schema: + type: integer + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configuration + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeAccessM2MList' + description: '' + post: + operationId: modules_registrations_options_accesses_m2m_create + description: |- + This view manages node configuration/access relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccessM2M' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeAccessM2M' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeAccessM2M' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccessM2M' + description: '' + /api/v2/modules_registrations/options/accesses_m2m/{id}/: + get: + operationId: modules_registrations_options_accesses_m2m_retrieve + description: |- + This view manages node configuration/access relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node access m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAccessM2M' + description: '' + delete: + operationId: modules_registrations_options_accesses_m2m_destroy + description: |- + This view manages node configuration/access relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node access m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/availabilities/: + get: + operationId: modules_registrations_options_availabilities_list + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configurations + schema: + type: array + items: + type: integer + explode: true + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeAvailabilityList' + description: '' + post: + operationId: modules_registrations_options_availabilities_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailability' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeAvailability' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeAvailability' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailability' + description: '' + /api/v2/modules_registrations/options/availabilities/{id}/: + get: + operationId: modules_registrations_options_availabilities_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node availability. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailability' + description: '' + patch: + operationId: modules_registrations_options_availabilities_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node availability. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeAvailability' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeAvailability' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeAvailability' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailability' + description: '' + delete: + operationId: modules_registrations_options_availabilities_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node availability. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/availabilities_m2m/: + get: + operationId: modules_registrations_options_availabilities_m2m_list + description: |- + This view manages node configuration/availabilities relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: query + name: availability + schema: + type: integer + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configuration + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeAvailabilityM2MList' + description: '' + post: + operationId: modules_registrations_options_availabilities_m2m_create + description: |- + This view manages node configuration/availabilities relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailabilityM2M' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeAvailabilityM2M' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeAvailabilityM2M' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailabilityM2M' + description: '' + /api/v2/modules_registrations/options/availabilities_m2m/{id}/: + get: + operationId: modules_registrations_options_availabilities_m2m_retrieve + description: |- + This view manages node configuration/availabilities relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node availability m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeAvailabilityM2M' + description: '' + delete: + operationId: modules_registrations_options_availabilities_m2m_destroy + description: |- + This view manages node configuration/availabilities relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node availability m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/conditions/: + get: + operationId: modules_registrations_options_conditions_list + description: |- + This view manages conditions + It filters conditions linked to configurations, via node configuration properties, which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedConditionList' + description: '' + post: + operationId: modules_registrations_options_conditions_create + description: |- + This view manages conditions + It filters conditions linked to configurations, via node configuration properties, which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Condition' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Condition' + multipart/form-data: + schema: + $ref: '#/components/schemas/Condition' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Condition' + description: '' + /api/v2/modules_registrations/options/conditions/{id}/: + get: + operationId: modules_registrations_options_conditions_retrieve + description: |- + This view manages conditions + It filters conditions linked to configurations, via node configuration properties, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this condition. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Condition' + description: '' + patch: + operationId: modules_registrations_options_conditions_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this condition. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedCondition' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedCondition' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedCondition' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Condition' + description: '' + delete: + operationId: modules_registrations_options_conditions_destroy + description: |- + This view manages conditions + It filters conditions linked to configurations, via node configuration properties, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this condition. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/extra_info_groups/: + get: + operationId: modules_registrations_options_extra_info_groups_list + description: |- + This view manages extra info group + It filters groups linked to configurations, via `NodeExtraInfoGroupM2M` through table, which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeExtraInfoGroupList' + description: '' + post: + operationId: modules_registrations_options_extra_info_groups_create + description: |- + This view manages extra info group + It filters groups linked to configurations, via `NodeExtraInfoGroupM2M` through table, which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + description: '' + /api/v2/modules_registrations/options/extra_info_groups/{id}/: + get: + operationId: modules_registrations_options_extra_info_groups_retrieve + description: |- + This view manages extra info group + It filters groups linked to configurations, via `NodeExtraInfoGroupM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info group. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + description: '' + patch: + operationId: modules_registrations_options_extra_info_groups_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info group. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfoGroup' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfoGroup' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfoGroup' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroup' + description: '' + delete: + operationId: modules_registrations_options_extra_info_groups_destroy + description: |- + This view manages extra info group + It filters groups linked to configurations, via `NodeExtraInfoGroupM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info group. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/extra_info_groups_m2m/: + get: + operationId: modules_registrations_options_extra_info_groups_m2m_list + description: |- + This view manages node configuration/extra group info relations. + PUT and PATCH methods are not supported. + It filters relations linked to configurations which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeExtraInfoGroupM2MList' + description: '' + post: + operationId: modules_registrations_options_extra_info_groups_m2m_create + description: |- + This view manages node configuration/extra group info relations. + PUT and PATCH methods are not supported. + It filters relations linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + description: '' + /api/v2/modules_registrations/options/extra_info_groups_m2m/{id}/: + get: + operationId: modules_registrations_options_extra_info_groups_m2m_retrieve + description: |- + This view manages node configuration/extra group info relations. + PUT and PATCH methods are not supported. + It filters relations linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info group + m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + description: '' + delete: + operationId: modules_registrations_options_extra_info_groups_m2m_destroy + description: |- + This view manages node configuration/extra group info relations. + PUT and PATCH methods are not supported. + It filters relations linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info group + m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/extra_infos/: + get: + operationId: modules_registrations_options_extra_infos_list + description: |- + This view manages extra infos + It filters extra infos linked to groups which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeExtraInfoList' + description: '' + post: + operationId: modules_registrations_options_extra_infos_create + description: |- + This view manages extra infos + It filters extra infos linked to groups which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + description: '' + /api/v2/modules_registrations/options/extra_infos/{id}/: + get: + operationId: modules_registrations_options_extra_infos_retrieve + description: |- + This view manages extra infos + It filters extra infos linked to groups which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + description: '' + patch: + operationId: modules_registrations_options_extra_infos_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfo' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfo' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeExtraInfo' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeExtraInfo' + description: '' + delete: + operationId: modules_registrations_options_extra_infos_destroy + description: |- + This view manages extra infos + It filters extra infos linked to groups which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node extra info. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/limits/: + get: + operationId: modules_registrations_options_limits_list + description: |- + This view manages limits + It filters limits linked to configurations, via `NodeLimitM2M` through table, which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configurations + schema: + type: array + items: + type: integer + explode: true + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeLimitList' + description: '' + post: + operationId: modules_registrations_options_limits_create + description: |- + This view manages limits + It filters limits linked to configurations, via `NodeLimitM2M` through table, which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimit' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeLimit' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeLimit' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimit' + description: '' + /api/v2/modules_registrations/options/limits/{id}/: + get: + operationId: modules_registrations_options_limits_retrieve + description: |- + This view manages limits + It filters limits linked to configurations, via `NodeLimitM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node limit. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimit' + description: '' + patch: + operationId: modules_registrations_options_limits_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node limit. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeLimit' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeLimit' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeLimit' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimit' + description: '' + delete: + operationId: modules_registrations_options_limits_destroy + description: |- + This view manages limits + It filters limits linked to configurations, via `NodeLimitM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node limit. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/limits_m2m/: + get: + operationId: modules_registrations_options_limits_m2m_list + description: |- + This view manages node configuration/limits relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: limit + schema: + type: integer + - in: query + name: node_configuration + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeLimitM2MList' + description: '' + post: + operationId: modules_registrations_options_limits_m2m_create + description: |- + This view manages node configuration/limits relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimitM2M' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeLimitM2M' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeLimitM2M' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimitM2M' + description: '' + /api/v2/modules_registrations/options/limits_m2m/{id}/: + get: + operationId: modules_registrations_options_limits_m2m_retrieve + description: |- + This view manages node configuration/limits relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node limit m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeLimitM2M' + description: '' + delete: + operationId: modules_registrations_options_limits_m2m_destroy + description: |- + This view manages node configuration/limits relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node limit m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/modules/: + get: + operationId: modules_registrations_options_modules_list + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationOptions`. + parameters: + - in: query + name: event + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedModuleRegistrationOptionsActiveModuleList' + description: '' + post: + operationId: modules_registrations_options_modules_create + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationOptions`. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + description: '' + /api/v2/modules_registrations/options/modules/{id}/: + get: + operationId: modules_registrations_options_modules_retrieve + description: ViewSet of model `ActiveModule` linked to `ModuleRegistrationOptions`. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + description: '' + patch: + operationId: modules_registrations_options_modules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this active module. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationOptionsActiveModule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationOptionsActiveModule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedModuleRegistrationOptionsActiveModule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + description: '' + /api/v2/modules_registrations/options/node_cart_configurations/: + get: + operationId: modules_registrations_options_node_cart_configurations_list + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeCartConfigurationList' + description: '' + post: + operationId: modules_registrations_options_node_cart_configurations_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + description: '' + /api/v2/modules_registrations/options/node_cart_configurations/{id}/: + get: + operationId: modules_registrations_options_node_cart_configurations_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node cart configuration. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + description: '' + patch: + operationId: modules_registrations_options_node_cart_configurations_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node cart configuration. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeCartConfiguration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeCartConfiguration' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeCartConfiguration' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeCartConfiguration' + description: '' + delete: + operationId: modules_registrations_options_node_cart_configurations_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node cart configuration. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/node_configurations/: + get: + operationId: modules_registrations_options_node_configurations_list + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeConfigurationList' + description: '' + post: + operationId: modules_registrations_options_node_configurations_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConfiguration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeConfiguration' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeConfiguration' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConfiguration' + description: '' + /api/v2/modules_registrations/options/node_configurations/{id}/: + get: + operationId: modules_registrations_options_node_configurations_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node configuration. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConfiguration' + description: '' + patch: + operationId: modules_registrations_options_node_configurations_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node configuration. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeConfiguration' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeConfiguration' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeConfiguration' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConfiguration' + description: '' + delete: + operationId: modules_registrations_options_node_configurations_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node configuration. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/nodes/: + get: + operationId: modules_registrations_options_nodes_list + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeList' + description: '' + post: + operationId: modules_registrations_options_nodes_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + description: '' + /api/v2/modules_registrations/options/nodes/{id}/: + get: + operationId: modules_registrations_options_nodes_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + description: '' + patch: + operationId: modules_registrations_options_nodes_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNode' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNode' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNode' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + description: '' + delete: + operationId: modules_registrations_options_nodes_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/nodes/{id}/actions/delete_cart_configurations/: + post: + operationId: modules_registrations_options_nodes_actions_delete_cart_configurations_create + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + description: '' + /api/v2/modules_registrations/options/nodes/{id}/actions/ensure_cart_configurations/: + post: + operationId: modules_registrations_options_nodes_actions_ensure_cart_configurations_create + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Node' + multipart/form-data: + schema: + $ref: '#/components/schemas/Node' + required: true + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + description: '' + /api/v2/modules_registrations/options/price_rules/: + get: + operationId: modules_registrations_options_price_rules_list + description: |- + This view manages price rules + It filters price rules linked to configurations, via `NodePriceRuleM2M` through table, which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configurations + schema: + type: array + items: + type: integer + explode: true + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodePriceRuleList' + description: '' + post: + operationId: modules_registrations_options_price_rules_create + description: |- + This view manages price rules + It filters price rules linked to configurations, via `NodePriceRuleM2M` through table, which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodePriceRule' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodePriceRule' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRule' + description: '' + /api/v2/modules_registrations/options/price_rules/{id}/: + get: + operationId: modules_registrations_options_price_rules_retrieve + description: |- + This view manages price rules + It filters price rules linked to configurations, via `NodePriceRuleM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node price rule. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRule' + description: '' + patch: + operationId: modules_registrations_options_price_rules_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node price rule. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodePriceRule' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodePriceRule' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodePriceRule' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRule' + description: '' + delete: + operationId: modules_registrations_options_price_rules_destroy + description: |- + This view manages price rules + It filters price rules linked to configurations, via `NodePriceRuleM2M` through table, which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node price rule. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/price_rules_m2m/: + get: + operationId: modules_registrations_options_price_rules_m2m_list + description: |- + This view manages node configuration/price rules relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configuration + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: price_rule + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodePriceRuleM2MList' + description: '' + post: + operationId: modules_registrations_options_price_rules_m2m_create + description: |- + This view manages node configuration/price rules relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRuleM2M' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodePriceRuleM2M' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodePriceRuleM2M' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRuleM2M' + description: '' + /api/v2/modules_registrations/options/price_rules_m2m/{id}/: + get: + operationId: modules_registrations_options_price_rules_m2m_retrieve + description: |- + This view manages node configuration/price rules relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node price rule m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodePriceRuleM2M' + description: '' + delete: + operationId: modules_registrations_options_price_rules_m2m_destroy + description: |- + This view manages node configuration/price rules relation + PUT and PATCH methods are not supported. + It filters relation linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node price rule m2m. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/promotion_codes/: + get: + operationId: modules_registrations_options_promotion_codes_list + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedPromotionCodeList' + description: '' + post: + operationId: modules_registrations_options_promotion_codes_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionCode' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PromotionCode' + multipart/form-data: + schema: + $ref: '#/components/schemas/PromotionCode' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionCode' + description: '' + /api/v2/modules_registrations/options/promotion_codes/{id}/: + get: + operationId: modules_registrations_options_promotion_codes_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this promotion code. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionCode' + description: '' + patch: + operationId: modules_registrations_options_promotion_codes_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this promotion code. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedPromotionCode' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedPromotionCode' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedPromotionCode' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionCode' + description: '' + delete: + operationId: modules_registrations_options_promotion_codes_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this promotion code. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/statements/: + get: + operationId: modules_registrations_options_statements_list + parameters: + - in: query + name: event_id + schema: + type: number + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatementList' + description: '' + post: + operationId: modules_registrations_options_statements_create + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Statement' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Statement' + multipart/form-data: + schema: + $ref: '#/components/schemas/Statement' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/Statement' + description: '' + /api/v2/modules_registrations/options/statements/{id}/: + get: + operationId: modules_registrations_options_statements_retrieve + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this statement. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Statement' + description: '' + patch: + operationId: modules_registrations_options_statements_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this statement. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedStatement' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedStatement' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedStatement' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Statement' + description: '' + delete: + operationId: modules_registrations_options_statements_destroy + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this statement. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/options/tags/: + get: + operationId: modules_registrations_options_tags_list + description: |- + This view manages node tags + It filters node tags linked to configurations which users have access to. + parameters: + - in: query + name: event_id + schema: + type: number + - in: query + name: node_configuration + schema: + type: array + items: + type: integer + description: Multiple values may be separated by commas. + explode: false + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedNodeTagList' + description: '' + post: + operationId: modules_registrations_options_tags_create + description: |- + This view manages node tags + It filters node tags linked to configurations which users have access to. + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTag' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/NodeTag' + multipart/form-data: + schema: + $ref: '#/components/schemas/NodeTag' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTag' + description: '' + /api/v2/modules_registrations/options/tags/{id}/: + get: + operationId: modules_registrations_options_tags_retrieve + description: |- + This view manages node tags + It filters node tags linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node tag. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTag' + description: '' + patch: + operationId: modules_registrations_options_tags_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node tag. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedNodeTag' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedNodeTag' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedNodeTag' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NodeTag' + description: '' + delete: + operationId: modules_registrations_options_tags_destroy + description: |- + This view manages node tags + It filters node tags linked to configurations which users have access to. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this node tag. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/modules_registrations/selected_nodes/: + get: + operationId: modules_registrations_selected_nodes_list + description: |- + This ViewSet manages SelectedNode. + The object is created during the add to basket process based on a copy of the node selected by the user. + parameters: + - in: query + name: basket_id + schema: + type: integer + - in: query + name: config + schema: + type: boolean + description: Whether the configuration is expanded in the response (rather + than represented with a pk). + - in: query + name: expand + schema: + type: boolean + description: Whether the children are expanded in the response (rather than + represented with a pk). + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSelectedNodeList' + description: '' + /api/v2/modules_registrations/selected_nodes/{id}/: + get: + operationId: modules_registrations_selected_nodes_retrieve + description: |- + This ViewSet manages SelectedNode. + The object is created during the add to basket process based on a copy of the node selected by the user. + parameters: + - in: query + name: config + schema: + type: boolean + description: Whether the configuration is expanded in the response (rather + than represented with a pk). + - in: query + name: expand + schema: + type: boolean + description: Whether the children are expanded in the response (rather than + represented with a pk). + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected node. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNode' + description: '' + /api/v2/modules_registrations/selected_nodes_extra_info_groups/: + get: + operationId: modules_registrations_selected_nodes_extra_info_groups_list + description: |- + This ViewSet manages SelectedNodeExtraInfoGroup. + The SelectedNodeExtraInfoGroup object is a copy of a NodeExtraInfoGroup which is created during the add to basket process. + parameters: + - in: query + name: id + schema: + type: array + items: + type: integer + description: Multiple values may be separated by commas. + explode: false + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + - in: query + name: selected_configuration_id + schema: + type: array + items: + type: number + description: Multiple values may be separated by commas. + explode: false + style: form + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSelectedNodeExtraInfoGroupList' + description: '' + /api/v2/modules_registrations/selected_nodes_extra_info_groups/{id}/: + get: + operationId: modules_registrations_selected_nodes_extra_info_groups_retrieve + description: |- + This ViewSet manages SelectedNodeExtraInfoGroup. + The SelectedNodeExtraInfoGroup object is a copy of a NodeExtraInfoGroup which is created during the add to basket process. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected node extra info + group. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeExtraInfoGroup' + description: '' + /api/v2/modules_registrations/selected_nodes_extra_infos/: + get: + operationId: modules_registrations_selected_nodes_extra_infos_list + description: |- + This ViewSet manages SelectedNodeExtraInfo. + The SelectedNodeExtraInfo object is a copy of a NodeExtraInfo which is created during the add to basket process. + parameters: + - in: query + name: groups + schema: + type: array + items: + type: integer + nullable: true + explode: true + style: form + - in: query + name: id + schema: + type: array + items: + type: integer + description: Multiple values may be separated by commas. + explode: false + style: form + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSelectedNodeExtraInfoList' + description: '' + /api/v2/modules_registrations/selected_nodes_extra_infos/{id}/: + get: + operationId: modules_registrations_selected_nodes_extra_infos_retrieve + description: |- + This ViewSet manages SelectedNodeExtraInfo. + The SelectedNodeExtraInfo object is a copy of a NodeExtraInfo which is created during the add to basket process. + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected node extra info. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeExtraInfo' + description: '' + patch: + operationId: modules_registrations_selected_nodes_extra_infos_partial_update + description: |- + Partial update (PATCH) definition + Returns: + response: the serialized data + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected node extra info. + required: true + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedSelectedNodeExtraInfo' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchedSelectedNodeExtraInfo' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchedSelectedNodeExtraInfo' + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedNodeExtraInfo' + description: '' + /api/v2/modules_registrations/selected_promotion_codes/: + get: + operationId: modules_registrations_selected_promotion_codes_list + description: |- + This ViewSet manages SelectedPromotionCode. + It allows to save that the user has entered a valid promo code on the ticketoffice homepage. + It's linked by a ForeignKey to a PromotionCode (where the promo code comes from). + parameters: + - in: query + name: basket + schema: + type: integer + - name: o + required: false + in: query + description: Which fields to use when ordering the results. + schema: + type: string + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + - name: page_limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: promotion_code + schema: + type: integer + - name: q + required: false + in: query + description: A search term. + schema: + type: string + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedSelectedPromotionCodeList' + description: '' + post: + operationId: modules_registrations_selected_promotion_codes_create + description: |- + This ViewSet manages SelectedPromotionCode. + It allows to save that the user has entered a valid promo code on the ticketoffice homepage. + It's linked by a ForeignKey to a PromotionCode (where the promo code comes from). + tags: + - modules_registrations + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedPromotionCode' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SelectedPromotionCode' + multipart/form-data: + schema: + $ref: '#/components/schemas/SelectedPromotionCode' + required: true + security: + - JWTAuth: [] + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedPromotionCode' + description: '' + /api/v2/modules_registrations/selected_promotion_codes/{id}/: + get: + operationId: modules_registrations_selected_promotion_codes_retrieve + description: |- + This ViewSet manages SelectedPromotionCode. + It allows to save that the user has entered a valid promo code on the ticketoffice homepage. + It's linked by a ForeignKey to a PromotionCode (where the promo code comes from). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected promotion code. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedPromotionCode' + description: '' + delete: + operationId: modules_registrations_selected_promotion_codes_destroy + description: |- + This ViewSet manages SelectedPromotionCode. + It allows to save that the user has entered a valid promo code on the ticketoffice homepage. + It's linked by a ForeignKey to a PromotionCode (where the promo code comes from). + parameters: + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this selected promotion code. + required: true + tags: + - modules_registrations + security: + - JWTAuth: [] + responses: + '204': + description: No response body + /api/v2/schema/: + get: + operationId: schema_retrieve + description: |- + OpenApi3 schema for this API. Format can be selected via content negotiation. + + - YAML: application/vnd.oai.openapi + - JSON: application/vnd.oai.openapi+json + parameters: + - in: query + name: format + schema: + type: string + enum: + - json + - yaml + - in: query + name: lang + schema: + type: string + enum: + - en + - fr + tags: + - schema + security: + - {} + responses: + '200': + content: + application/vnd.oai.openapi: + schema: + type: object + additionalProperties: {} + application/yaml: + schema: + type: object + additionalProperties: {} + application/vnd.oai.openapi+json: + schema: + type: object + additionalProperties: {} + application/json: + schema: + type: object + additionalProperties: {} + description: '' +components: + schemas: + AccessManagementPlace: + type: object + description: Serializer for AccessManagementPlace model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 64 + configuration: + type: integer + expires_at: + type: string + format: date-time + nullable: true + monomode_testing_url: + type: string + readOnly: true + description: URL of the access management scanner for this place, in testing + mode. + monomode_url: + type: string + readOnly: true + description: URL of the access management scanner for this place. + required: + - configuration + - id + - monomode_testing_url + - monomode_url + - name + AddToBasketNodeExtraInfo: + type: object + description: |- + A serializer to be used exclusively inside the AddToBasketNodeExtraInfoGroupSerializer. + This is used to specify which NodeExtraInfo you are submitting a value for, and the value itself in one go + properties: + node_extra_info: + type: integer + value: + type: string + required: + - node_extra_info + - value + AddToBasketNodeExtraInfoGroup: + type: object + description: |- + A serializer to be used exclusively inside the SelectedNodeCreationSerializer. + This facilates submitting the values (responses) for all NodeExtraInfos of a NodeExtraInfoGroup in one go + properties: + node_extra_infos: + type: array + items: + $ref: '#/components/schemas/AddToBasketNodeExtraInfo' + node_extra_info_group: + type: integer + required: + - node_extra_info_group + - node_extra_infos + ApiToken: + type: object + properties: + id: + type: integer + readOnly: true + user: + type: integer + readOnly: true + nullable: true + frontend_logins: + type: array + items: + type: integer + readOnly: true + is_automatic: + type: boolean + readOnly: true + description: True if the token has been generated automatically + name: + type: string + readOnly: true + description: Informative name, for you :) + expiration: + type: string + format: date-time + readOnly: true + nullable: true + description: When the token should expire. Leave blank for an infinitely + valid token (not recommended!) + required: + - expiration + - frontend_logins + - id + - is_automatic + - name + - user + BillingInformation: + type: object + description: |- + Serializer for BillingInformation model + Requires to be logged in as a user or to provide a frontend login associated with your request + properties: + id: + type: integer + readOnly: true + first_name: + type: string + maxLength: 50 + last_name: + type: string + maxLength: 50 + address: + type: string + maxLength: 100 + postal_code: + type: string + maxLength: 20 + city: + type: string + maxLength: 50 + country: + type: string + maxLength: 50 + email: + type: string + format: email + maxLength: 255 + user: + type: integer + readOnly: true + nullable: true + created_by: + type: integer + nullable: true + frontendbasket_set: + type: array + items: + type: integer + readOnly: true + required: + - email + - frontendbasket_set + - id + - user + BlankEnum: + enum: + - '' + CancelError: + type: object + properties: + error: + type: string + description: Error in case the payment intent was not in a cancellable state + (paid or already cancelled). + required: + - error + CategoryEnum: + enum: + - ticket + - item + - activity + - accomodation + - type + - group + type: string + description: |- + * `ticket` - Ticket + * `item` - Item + * `activity` - Activity + * `accomodation` - Accomodation + * `type` - Type + * `group` - Group + CompletionStarted: + type: object + description: Serializer for CompletionStartedViewSet + properties: + basket_id: + type: integer + writeOnly: true + description: The ID of the frontend basket. + required: + - basket_id + Condition: + type: object + description: Serializer (read/write) for `Condition` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + maxLength: 128 + logical_operator: + allOf: + - $ref: '#/components/schemas/LogicalOperatorEnum' + description: |- + the logical operator used between multiple statements + + * `or` - OR + * `and` - AND + is_implicit: + type: boolean + title: Is implicit? + description: can store a combination of conditions as a single condition + required: + - event + - event_id + - id + - logical_operator + ConfirmationPageExtraTextActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ConfirmationPageExtraTextConfiguration' + required: + - config + - event + - id + ConfirmationPageExtraTextConfiguration: + type: object + description: Serializer for `ModuleCompletionConfirmationPageExtraTextConfiguration` + nested in `ConfirmationPageExtraTextActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + text: + type: string + description: Text that is displayed on the order confirmation page. Some + restricted HTML markup is allowed, everything else is filtered out automatically. + image: + type: integer + nullable: true + description: The image used for the module + is_text_used: + type: boolean + title: Is module's text used + is_image_used: + type: boolean + title: Is module's image used + required: + - id + CreateAnonymousLogin: + type: object + description: |- + Serializer used for AnonymousLogin creation. + Adds `testing` (default to False) in data if not given. + properties: + active_module_id: + type: integer + writeOnly: true + testing: + type: boolean + writeOnly: true + default: false + required: + - active_module_id + CreateTrustedEmailLogin: + type: object + description: |- + Serializer used for TrustedEmailLogin creation. + Adds `testing` (default to False) in data if not given and forces `email` to be provided. + properties: + active_module_id: + type: integer + writeOnly: true + testing: + type: boolean + writeOnly: true + default: false + email: + type: string + format: email + writeOnly: true + required: + - active_module_id + - email + Document: + type: object + description: Serializer for `Document` model + properties: + id: + type: integer + readOnly: true + is_active: + type: boolean + readOnly: true + type: + $ref: '#/components/schemas/DocumentTypeEnum' + file: + type: string + maxLength: 128 + required: + - file + - id + - is_active + - type + DocumentTypeEnum: + enum: + - privacy_policy + - terms_of_service + - imprint + type: string + description: |- + * `privacy_policy` - Privacy policy + * `terms_of_service` - Terms of service + * `imprint` - Imprint + Event: + type: object + description: Serializer for Node model + properties: + id: + type: integer + readOnly: true + unit_id: + type: integer + name: + type: string + maxLength: 255 + status: + $ref: '#/components/schemas/EventStatusEnum' + moderation_status: + allOf: + - $ref: '#/components/schemas/ModerationStatusEnum' + readOnly: true + are_registrations_allowed: + type: boolean + readOnly: true + are_payments_allowed: + type: boolean + readOnly: true + registrations_start_date: + type: string + format: date-time + nullable: true + payments_start_date: + type: string + format: date-time + nullable: true + payments_end_date: + type: string + format: date-time + nullable: true + closed_start_date: + type: string + format: date + nullable: true + registrations_end_date: + type: string + format: date-time + nullable: true + start_date: + type: string + format: date-time + nullable: true + end_date: + type: string + format: date-time + nullable: true + custom_key: + type: string + maxLength: 128 + welcome_text: + type: string + description: Welcome text displayed on the Ticket Office event page. Some + restricted HTML markup is allowed, everything else is filtered out automatically. + frontend_url: + type: string + format: uri + description: External url provided by the organizer. I.e. their website + or social media page + maxLength: 200 + frontend_title: + type: string + description: Main name of the event shown to end users. I.e. shown on the + Ticket Office webpage + maxLength: 128 + frontend_organizers: + type: string + description: Name of the organizer, displayed on the Ticket Office event + page + maxLength: 128 + frontend_path: + type: string + description: Root of public path of the event url + maxLength: 128 + multiple_registration_per_login: + type: boolean + user_nickname_enabled: + type: boolean + user_registration_link_unique: + type: boolean + description_header_image: + type: integer + nullable: true + terms_of_service: + type: string + maxLength: 128 + location_text: + type: string + maxLength: 255 + location: + type: string + nullable: true + location_address: + type: string + readOnly: true + title: Location address (via reverse lookup) + is_public_visible: + type: boolean + is_unit_visible: + type: boolean + ticket_office_url: + type: string + readOnly: true + ticket_office_testing_url: + type: string + readOnly: true + is_basket_item_modification_allowed: + type: boolean + description: This field informs the front end on what actions should be + allowed or prevented, in the front end only. + is_in_lausanne: + type: boolean + description: if the event physically takes place in the city of Lausanne, + set this boolean so that taxes are calculated properly + is_status_public: + type: boolean + readOnly: true + required: + - are_payments_allowed + - are_registrations_allowed + - frontend_path + - frontend_title + - id + - is_status_public + - location_address + - moderation_status + - name + - ticket_office_testing_url + - ticket_office_url + - unit_id + EventModeration: + type: object + description: Write only serializer, used by admin to validate an event. + properties: + is_valid: + type: boolean + writeOnly: true + description: Whether the event is deemed valid by an admin. + required_changes: + type: string + writeOnly: true + description: Short description of what the user should modify on his event, + so we can publish it. + required: + - is_valid + EventPublicInfos: + type: object + description: Serializer for the public infos endpoint + properties: + id: + type: integer + readOnly: true + are_registrations_allowed: + type: boolean + readOnly: true + are_payments_allowed: + type: boolean + readOnly: true + welcome_text: + type: string + readOnly: true + description: Welcome text displayed on the Ticket Office event page + frontend_url: + type: string + format: uri + readOnly: true + description: External url provided by the organizer. I.e. their website + or social media page + frontend_title: + type: string + readOnly: true + description: Main name of the event shown to end users. I.e. shown on the + Ticket Office webpage + frontend_organizers: + type: string + readOnly: true + description: Name of the organizer, displayed on the Ticket Office event + page + description_header_image: + type: integer + readOnly: true + nullable: true + start_date: + type: string + format: date-time + readOnly: true + nullable: true + end_date: + type: string + format: date-time + readOnly: true + nullable: true + location_text: + type: string + readOnly: true + location: + type: string + readOnly: true + nullable: true + location_address: + type: string + readOnly: true + title: Location address (via reverse lookup) + is_basket_item_modification_allowed: + type: boolean + readOnly: true + description: This field informs the front end on what actions should be + allowed or prevented, in the front end only. + is_status_public: + type: boolean + readOnly: true + required: + - are_payments_allowed + - are_registrations_allowed + - description_header_image + - end_date + - frontend_organizers + - frontend_title + - frontend_url + - id + - is_basket_item_modification_allowed + - is_status_public + - location + - location_address + - location_text + - start_date + - welcome_text + EventStatistics: + type: object + description: Serializer for the action event-statistics used to display the + dashboard of an event + properties: + invoices_resolved: + type: object + additionalProperties: {} + readOnly: true + description: associate the number of invoices resolved (INCLUDING the refunded + ones) per timestamps + invoices_resolved_value: + type: object + additionalProperties: {} + readOnly: true + description: associate the value of the total amount from the invoices resolved + (INCLUDING the refunded ones) per timestamps + invoices_refunded: + type: object + additionalProperties: {} + readOnly: true + description: associate the number of invoices refunded (only those FULLY + refunded) per timestamps + invoices_refunded_value: + type: object + additionalProperties: {} + readOnly: true + description: associate the value of the total amount from invoices refunded + (= invoices with negative amounts) per timestamps + invoices_in_progress: + type: integer + readOnly: true + description: the count of invoices that are still in progress + required: + - invoices_in_progress + - invoices_refunded + - invoices_refunded_value + - invoices_resolved + - invoices_resolved_value + EventStatusEnum: + enum: + - draft + - public + - closed + - archived + type: string + description: |- + * `draft` - Draft + * `public` - Public + * `closed` - Closed (force) + * `archived` - Archived + FrontendBasket: + type: object + properties: + id: + type: integer + readOnly: true + event: + type: integer + testing: + type: boolean + readOnly: true + created_by_id: + type: integer + description: The id of the frontendlogin that created the basket. + billing_information_id: + type: integer + description: The id of the billing information linked to the basket. + total: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + readOnly: true + total_display: + type: string + readOnly: true + invoices: + type: array + items: + type: integer + readOnly: true + unikey: + type: string + description: Return a unique and checksummed-ish key + readOnly: true + status: + type: string + readOnly: true + registrations_count: + type: integer + readOnly: true + description: The number of root Selected Nodes linked to this basket. + invoices_total: + type: number + format: double + readOnly: true + description: Invoices total amount. + invoices_total_exceeds_basket_total: + type: boolean + readOnly: true + description: Whether the invoices total amount exceeds the basket total. + required: + - created_by_id + - event + - id + - invoices + - invoices_total + - invoices_total_exceeds_basket_total + - registrations_count + - status + - testing + - total + - total_display + - unikey + FrontendLogin: + type: object + description: Serializer for FrontendLogin + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + testing: + type: boolean + readOnly: true + email: + type: string + format: email + readOnly: true + nullable: true + username: + type: string + readOnly: true + user: + type: integer + readOnly: true + nullable: true + display: + type: string + readOnly: true + required: + - display + - email + - event + - id + - testing + - user + - username + Invoice: + type: object + description: Serializer for `Invoice` model + properties: + id: + type: integer + readOnly: true + amount: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + readOnly: true + due_date: + type: string + format: date-time + readOnly: true + nullable: true + created_at: + type: string + format: date-time + readOnly: true + basket: + type: integer + readOnly: true + nullable: true + is_cancelled: + type: boolean + readOnly: true + related_invoices: + type: array + items: + type: integer + readOnly: true + is_resolved: + type: boolean + readOnly: true + required: + - amount + - basket + - created_at + - due_date + - id + - is_cancelled + - is_resolved + - related_invoices + LeftHandOperandEnum: + enum: + - login + - node + - promotion_code + type: string + description: |- + * `login` - Login property + * `node` - Node selected + * `promotion_code` - Promotion code + LogicalOperatorEnum: + enum: + - or + - and + type: string + description: |- + * `or` - OR + * `and` - AND + Login: + type: object + description: Serializer used only for PolyTicketUser login. + properties: + email: + type: string + format: email + writeOnly: true + description: The email associated with your account + password: + type: string + writeOnly: true + description: The password associated with your account + required: + - email + - password + LoginJWT: + type: object + description: Serializer used to return the login access token. + properties: + jwt: + type: string + readOnly: true + description: The login JWT access token + required: + - jwt + LoginMethod: + type: object + description: A serializer returning info for a login method + properties: + active_module_id: + type: integer + readOnly: true + description: The id of the login method's active module + key: + type: string + readOnly: true + name: + type: string + readOnly: true + description: Title of the login method + description: + type: string + readOnly: true + description: Description of the login method + required: + - active_module_id + - description + - key + - name + LoginResult: + type: object + description: Serializer used only to return the token after a user login. + properties: + token: + type: string + description: A JWT to be used in Bearer authentication in further requests. + required: + - token + ModeEnum: + enum: + - plus + - set + - plus_percent + - multiply + - divide + type: string + description: |- + * `plus` - + [Current price + value] + * `set` - = [Set price to] + * `plus_percent` - +% [Current price + current price * value / 100] + * `multiply` - * [Current price * value] + * `divide` - / [Current price / value] + ModelFormLineType: + enum: + - text + - email + - phone + - country + - numerical + - textarea + - boolean + - datetime + - date + - date_major + - choice + - file + type: string + description: |- + * `text` - Simple text + * `email` - Email + * `phone` - Phone + * `country` - Country + * `numerical` - Numerical + * `textarea` - Multi-line text input + * `boolean` - Boolean + * `datetime` - Datetime + * `date` - Date + * `date_major` - Birthdate with majority required + * `choice` - Choice + * `file` - File + ModerationStatusEnum: + enum: + - not_requested + - requested + - change_requested + - validated + type: string + description: |- + * `not_requested` - Not requested + * `requested` - Requested + * `change_requested` - Change requested + * `validated` - Validated + ModuleAuthAnonymousLoginActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthAnonymousLogin` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginConfiguration' + required: + - config + - event + - id + ModuleAuthAnonymousLoginConfiguration: + type: object + description: Serializer for `ModuleAuthAnonymousLoginConfiguration` nested in + `ModuleAuthAnonymousLoginActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + required: + - id + ModuleAuthThirdPartyTokenLoginActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginConfiguration' + required: + - config + - event + - id + ModuleAuthThirdPartyTokenLoginConfiguration: + type: object + description: Serializer for `ModuleAuthThirdPartyTokenLoginConfiguration` nested + in `ModuleAuthThirdPartyTokenLoginActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + jwt_secret_key: + type: string + title: JWT Secret key for the login token + description: Secret key for the JWT token (any string). + maxLength: 255 + required: + - id + - jwt_secret_key + ModuleAuthTrustedEmailActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthTrustedEmail` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthTrustedEmailConfiguration' + required: + - config + - event + - id + ModuleAuthTrustedEmailConfiguration: + type: object + description: Serializer for `ModuleAuthTrustedEmailConfiguration` nested in + `ModuleAuthTrustedEmailActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + required: + - id + ModuleCompletionEmailRegistrationCompletedActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedConfiguration' + required: + - config + - event + - id + ModuleCompletionEmailRegistrationCompletedConfiguration: + type: object + description: Serializer for `ModuleCompletionEmailRegistrationCompletedConfiguration` + nested in `ModuleCompletionEmailRegistrationCompletedActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + ticket_content: + type: string + event_details_dates: + type: string + maxLength: 255 + event_details_location_text: + type: string + maxLength: 255 + event_details_location_image: + type: string + nullable: true + maxLength: 128 + text: + type: string + description: custom text to be displayed on the confirmation email. Some + restricted HTML markup is allowed, everything else is filtered out automatically. + image: + type: integer + nullable: true + description: The image used for the module + is_text_used: + type: boolean + title: Is module's text used + is_image_used: + type: boolean + title: Is module's image used + required: + - id + ModuleCompletionEmailRegistrationCreationActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationConfiguration' + required: + - config + - event + - id + ModuleCompletionEmailRegistrationCreationConfiguration: + type: object + description: Serializer for `ModuleCompletionEmailRegistrationCreationConfiguration` + nested in `ModuleCompletionEmailRegistrationCreationActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + delay: + type: integer + maximum: 2147483647 + minimum: 0 + description: delay time in minutes + is_disabled_if_paid: + type: boolean + title: Should be disabled if paid? + text: + type: string + description: custom text to be displayed on the reminder email. Some restricted + HTML markup is allowed, everything else is filtered out automatically. + image: + type: integer + nullable: true + description: The image used for the module + is_text_used: + type: boolean + title: Is module's text used + is_image_used: + type: boolean + title: Is module's image used + required: + - id + ModuleCompletionPDFTicketActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionPDFTicket` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionPDFTicketConfiguration' + required: + - config + - event + - id + ModuleCompletionPDFTicketConfiguration: + type: object + description: Serializer for `ModuleCompletionPDFTicketConfiguration` nested + in `ModuleCompletionPDFTicketActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + text: + type: string + description: The complementary informations's text on the PDF ticket. Some + restricted HTML markup is allowed, everything else is filtered out automatically. + image: + type: integer + nullable: true + description: The image used for the module + is_text_used: + type: boolean + title: Is module's text used + is_image_used: + type: boolean + title: Is module's image used + required: + - id + ModuleCompletionRedirectActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionRedirect` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionRedirectConfiguration' + required: + - config + - event + - id + ModuleCompletionRedirectConfiguration: + type: object + description: Serializer for `ModuleCompletionRedirectConfiguration` nested in + `ModuleCompletionRedirectActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + redirect_url: + type: string + format: uri + description: Redirect URL once the payment is done. + maxLength: 255 + required: + - id + - redirect_url + ModulePaymentPayrexxActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModulePaymentPayrexx` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModulePaymentPayrexxConfiguration' + required: + - config + - event + - id + ModulePaymentPayrexxConfiguration: + type: object + description: Serializer for `ModulePaymentPayrexxConfiguration` nested in `ModulePaymentPayrexxActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + is_feature_disabled: + type: boolean + title: Is feature disabled? + payment_list_title: + type: string + maxLength: 255 + payment_list_description: + type: string + timeout: + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true + price_rules: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPayrexxConfigurationPriceRule' + readOnly: true + limits: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPayrexxConfigurationLimit' + readOnly: true + global_limits: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPayrexxConfigurationGlobalLimit' + readOnly: true + required: + - global_limits + - id + - limits + - price_rules + ModulePaymentPayrexxConfigurationGlobalLimit: + type: object + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + key: + type: string + readOnly: true + conditions_json: + type: string + readOnly: true + nullable: true + required: + - conditions_json + - id + - key + - order + ModulePaymentPayrexxConfigurationLimit: + type: object + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + global_order: + type: integer + readOnly: true + label: + type: string + readOnly: true + maximum: + type: integer + readOnly: true + conditions_json: + type: string + readOnly: true + nullable: true + required: + - conditions_json + - global_order + - id + - label + - maximum + - order + ModulePaymentPayrexxConfigurationPriceRule: + type: object + properties: + id: + type: integer + readOnly: true + global_order: + type: integer + readOnly: true + order: + type: integer + readOnly: true + mode: + allOf: + - $ref: '#/components/schemas/ModeEnum' + readOnly: true + value: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + readOnly: true + label: + type: string + readOnly: true + should_propagate: + type: boolean + readOnly: true + description: does this rule apply on children of the node + conditions_json: + type: string + readOnly: true + nullable: true + required: + - conditions_json + - global_order + - id + - label + - mode + - order + - should_propagate + - value + ModulePaymentPointOfSaleActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModulePaymentPointOfSale` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModulePaymentPointOfSaleConfiguration' + required: + - config + - event + - id + ModulePaymentPointOfSaleConfiguration: + type: object + description: Serializer for `ModulePaymentPointOfSaleConfiguration` nested in + `ModulePaymentPointOfSaleActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + is_feature_disabled: + type: boolean + title: Is feature disabled? + payment_list_title: + type: string + maxLength: 255 + payment_list_description: + type: string + places_list_title: + type: string + maxLength: 255 + places_list_text: + type: string + timeout: + type: integer + maximum: 2147483647 + minimum: -2147483648 + nullable: true + title: Timout + description: In minutes + places: + type: array + items: + $ref: '#/components/schemas/PointOfSalePlace' + readOnly: true + price_rules: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPointOfSaleConfigurationPriceRule' + readOnly: true + limits: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPointOfSaleConfigurationLimit' + readOnly: true + global_limits: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPointOfSaleConfigurationGlobalLimit' + readOnly: true + required: + - global_limits + - id + - limits + - places + - price_rules + ModulePaymentPointOfSaleConfigurationGlobalLimit: + type: object + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + key: + type: string + readOnly: true + conditions_json: + type: string + readOnly: true + required: + - conditions_json + - id + - key + - order + ModulePaymentPointOfSaleConfigurationLimit: + type: object + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + global_order: + type: integer + readOnly: true + label: + type: string + readOnly: true + maximum: + type: integer + readOnly: true + conditions_json: + type: string + readOnly: true + required: + - conditions_json + - global_order + - id + - label + - maximum + - order + ModulePaymentPointOfSaleConfigurationPriceRule: + type: object + properties: + id: + type: integer + readOnly: true + global_order: + type: integer + readOnly: true + order: + type: integer + readOnly: true + mode: + allOf: + - $ref: '#/components/schemas/ModeEnum' + readOnly: true + value: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + readOnly: true + label: + type: string + readOnly: true + should_propagate: + type: boolean + readOnly: true + description: does this rule apply on children of the node + conditions_json: + type: string + readOnly: true + required: + - conditions_json + - global_order + - id + - label + - mode + - order + - should_propagate + - value + ModuleRegistrationAccessManagementActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleRegistrationOptions` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleRegistrationsAccessManagementConfiguration' + required: + - config + - event + - id + ModuleRegistrationOptionsActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleRegistrationOptions` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleRegistrationOptionsConfiguration' + required: + - config + - event + - id + ModuleRegistrationOptionsConfiguration: + type: object + description: Serializer for `ModuleRegistrationOptionsConfiguration` nested + in `ModuleRegistrationOptionsActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + title: + type: string + maxLength: 128 + description: + type: string + title_summary: + type: string + maxLength: 128 + display_summary: + type: boolean + root_node: + type: integer + readOnly: true + nullable: true + required: + - id + - root_node + ModuleRegistrationsAccessManagementConfiguration: + type: object + description: Serializer for `ModuleRegistrationOptionsConfiguration` nested + in `ModuleRegistrationOptionsActiveModuleSerializer` + properties: + id: + type: integer + readOnly: true + required: + - id + Node: + type: object + description: Serializer for Node model + properties: + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: Local order between nodes that share the same parent + parent_id: + type: integer + internal_key: + type: string + maxLength: 128 + configuration_id: + type: integer + cart_configuration_id: + type: integer + children_ids: + type: array + items: + type: integer + readOnly: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - children_ids + - configuration_id + - event + - event_id + - id + - order + - parent_id + NodeAccess: + type: object + description: Serializer (read/write) for `NodeAccess` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + label: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + is_accessible: + type: boolean + description: if True and user matches the conditions they should have access + to the node, if False and user matches the conditions they should not + have access to the node + required: + - event + - event_id + - id + - label + - node_configuration_ids + NodeAccessM2M: + type: object + description: Serializer (read/write) for `NodeAccessM2M` relation model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + access_id: + type: integer + node_configuration_id: + type: integer + required: + - access_id + - event + - event_id + - id + - node_configuration_id + NodeAvailability: + type: object + description: Serializer (read/write) for NodeAvailability model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + starts_at: + type: string + format: date-time + nullable: true + ends_at: + type: string + format: date-time + nullable: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - id + - name + - node_configuration_ids + NodeAvailabilityM2M: + type: object + description: Serializer (read/write) for `NodeAvailabilityM2M` relation model + properties: + id: + type: integer + readOnly: true + availability_id: + type: integer + node_configuration_id: + type: integer + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - availability_id + - event + - event_id + - id + - node_configuration_id + NodeCartConfiguration: + type: object + description: Serializer (read/write) for NodeCartConfiguration model + properties: + id: + type: integer + readOnly: true + weight: + type: integer + maximum: 2147483647 + minimum: -2147483648 + range_min: + type: integer + maximum: 2147483647 + minimum: -2147483648 + title: Range minimum + range_max: + type: integer + maximum: 2147483647 + minimum: -2147483648 + title: Range maximum + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - id + NodeConfiguration: + type: object + description: Serializer (read/write) for NodeConfiguration model + properties: + id: + type: integer + readOnly: true + description: + type: string + description: description for the node. Some restricted HTML markup is allowed, + everything else is filtered out automatically. + title: + type: string + maxLength: 128 + category: + $ref: '#/components/schemas/CategoryEnum' + image: + type: integer + nullable: true + image_style: {} + item_style: {} + display_price_difference: + type: boolean + display_limits_difference: + type: boolean + is_title_displayable: + type: boolean + is_image_displayable: + type: boolean + is_description_displayable: + type: boolean + is_tags_displayable: + type: boolean + starts_at: + type: string + format: date-time + nullable: true + description: Optional start datetime for this node. For display only. + ends_at: + type: string + format: date-time + nullable: true + description: Optional end datetime for this node. For display only. + is_subject_to_lausanne_tax: + type: boolean + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - id + NodeExtraInfo: + type: object + description: Serializer (read/write) for `NodeExtraInfo` model + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + type: + $ref: '#/components/schemas/ModelFormLineType' + name: + type: string + maxLength: 256 + text: + type: string + maxLength: 256 + help_text: + type: string + maxLength: 512 + is_required: + type: boolean + choices_json: + type: string + nullable: true + major_json: + type: string + nullable: true + range_json: + type: string + nullable: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - group_id + - id + - name + - order + - text + - type + NodeExtraInfoGroup: + type: object + description: Serializer (read/write) for `NodeExtraInfoGroup` model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 256 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + is_inline: + type: boolean + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + extra_info_ids: + type: array + items: + type: integer + readOnly: true + is_required: + type: boolean + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - extra_info_ids + - id + - name + - node_configuration_ids + - order + NodeExtraInfoGroupM2M: + type: object + description: Serializer (read/write) for `NodeExtraInfoGroupM2M` relation model + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + node_configuration_id: + type: integer + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + required: + - event + - event_id + - group_id + - id + - node_configuration_id + NodeLimit: + type: object + description: Serializer (read/write) for `NodeLimit` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + is_deleted: + type: boolean + key: + type: string + maxLength: 64 + label: + type: string + maxLength: 256 + maximum: + type: integer + maximum: 2147483647 + minimum: -2147483648 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + global_order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + required: + - event + - event_id + - global_order + - id + - key + - label + - maximum + - node_configuration_ids + - order + NodeLimitM2M: + type: object + description: Serializer (read/write) for `NodeLimitM2M` relation model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + limit_id: + type: integer + node_configuration_id: + type: integer + required: + - event + - event_id + - id + - limit_id + - node_configuration_id + NodeLimitUsage: + type: object + description: Serializer for node used on node stock endpoints. + properties: + label: + type: string + readOnly: true + description: Label of related limit. + count_reserved: + type: integer + readOnly: true + description: Number of times this limit has been taken. + maximum: + type: integer + readOnly: true + description: Maximum of times this limit can be taken. + remaining: + type: integer + readOnly: true + description: Number of times left. + required: + - count_reserved + - label + - maximum + - remaining + NodePriceRule: + type: object + description: Serializer (read/write) for `NodePriceRule` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + global_order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + mode: + $ref: '#/components/schemas/ModeEnum' + value: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + label: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + should_propagate: + type: boolean + description: does this rule apply on children of the node + required: + - event + - event_id + - global_order + - id + - label + - mode + - node_configuration_ids + - order + - value + NodePriceRuleM2M: + type: object + description: Serializer (read/write) for `NodePriceRuleM2M` relation model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + price_rule_id: + type: integer + node_configuration_id: + type: integer + required: + - event + - event_id + - id + - node_configuration_id + - price_rule_id + NodeStock: + type: object + description: Serializer for mapping the stock of each Node. + properties: + id: + type: integer + readOnly: true + description: Id of node + title: + type: string + readOnly: true + description: Title of the equivalent `SelectedRootNode` + root_path: + type: array + items: + type: string + readOnly: true + description: List of title on the path from root to the node. + count_total: + type: integer + readOnly: true + description: Total number of items that have been purchased, are being purchased, + have been refunded or are only added to a basket. + count_new: + type: integer + readOnly: true + description: Number of items that are in a basket (but not purchased, nor + are being purchased, nor refunded) + count_payment_in_progress: + type: integer + readOnly: true + description: Number of items that are currently being purchased. + count_validated: + type: integer + readOnly: true + description: Number of items that have been purchased. + count_reserved: + type: integer + readOnly: true + description: Number of items that are reserved (validated + being paid). + count_refunded: + type: integer + readOnly: true + description: Number of items that have been refunded. + limits: + type: array + items: + $ref: '#/components/schemas/NodeLimitUsage' + readOnly: true + description: Any stock limits that this item has + required: + - count_new + - count_payment_in_progress + - count_refunded + - count_reserved + - count_total + - count_validated + - id + - limits + - root_path + - title + NodeTag: + type: object + description: Serializer (read/write) for `NodeTag` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + maxLength: 255 + node_configuration_id: + type: integer + required: + - event + - event_id + - id + - name + - node_configuration_id + OperatorEnum: + enum: + - '>' + - '>=' + - '=' + - '!=' + - < + - <= + - exists + - contains + - is in + type: string + description: |- + * `>` - Greater + * `>=` - Greater Or Equal + * `=` - Equal + * `!=` - Not Equal + * `<` - Less + * `<=` - Less Or Equal + * `exists` - Exists + * `contains` - Contains + * `is in` - Is In + PaginatedAccessManagementPlaceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/AccessManagementPlace' + PaginatedApiTokenList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ApiToken' + PaginatedBillingInformationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/BillingInformation' + PaginatedConditionList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Condition' + PaginatedConfirmationPageExtraTextActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ConfirmationPageExtraTextActiveModule' + PaginatedDocumentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Document' + PaginatedEventList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Event' + PaginatedFrontendBasketList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FrontendBasket' + PaginatedFrontendLoginList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/FrontendLogin' + PaginatedInvoiceList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Invoice' + PaginatedLoginMethodList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/LoginMethod' + PaginatedModuleAuthAnonymousLoginActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginActiveModule' + PaginatedModuleAuthThirdPartyTokenLoginActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginActiveModule' + PaginatedModuleAuthTrustedEmailActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleAuthTrustedEmailActiveModule' + PaginatedModuleCompletionEmailRegistrationCompletedActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedActiveModule' + PaginatedModuleCompletionEmailRegistrationCreationActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationActiveModule' + PaginatedModuleCompletionPDFTicketActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleCompletionPDFTicketActiveModule' + PaginatedModuleCompletionRedirectActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleCompletionRedirectActiveModule' + PaginatedModulePaymentPayrexxActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPayrexxActiveModule' + PaginatedModulePaymentPointOfSaleActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModulePaymentPointOfSaleActiveModule' + PaginatedModuleRegistrationAccessManagementActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleRegistrationAccessManagementActiveModule' + PaginatedModuleRegistrationOptionsActiveModuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/ModuleRegistrationOptionsActiveModule' + PaginatedNodeAccessList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeAccess' + PaginatedNodeAccessM2MList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeAccessM2M' + PaginatedNodeAvailabilityList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeAvailability' + PaginatedNodeAvailabilityM2MList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeAvailabilityM2M' + PaginatedNodeCartConfigurationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeCartConfiguration' + PaginatedNodeConfigurationList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeConfiguration' + PaginatedNodeExtraInfoGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeExtraInfoGroup' + PaginatedNodeExtraInfoGroupM2MList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeExtraInfoGroupM2M' + PaginatedNodeExtraInfoList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeExtraInfo' + PaginatedNodeLimitList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeLimit' + PaginatedNodeLimitM2MList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeLimitM2M' + PaginatedNodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Node' + PaginatedNodePriceRuleList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodePriceRule' + PaginatedNodePriceRuleM2MList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodePriceRuleM2M' + PaginatedNodeTagList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/NodeTag' + PaginatedPaymentIntentList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PaymentIntent' + PaginatedPaymentMethodList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PaymentMethod' + PaginatedPointOfSalePlaceReadOnlyList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PointOfSalePlaceReadOnly' + PaginatedPolyTicketUserList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PolyTicketUser' + PaginatedPromotionCodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/PromotionCode' + PaginatedSelectedNodeExtraInfoGroupList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SelectedNodeExtraInfoGroup' + PaginatedSelectedNodeExtraInfoList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SelectedNodeExtraInfo' + PaginatedSelectedNodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SelectedNode' + PaginatedSelectedPromotionCodeList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/SelectedPromotionCode' + PaginatedStatementList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Statement' + PaginatedUnitList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/Unit' + PaginatedUnitMembershipList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/UnitMembership' + PaginatedUploadedImageList: + type: object + required: + - count + - results + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=400&page_limit=100 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?offset=200&page_limit=100 + results: + type: array + items: + $ref: '#/components/schemas/UploadedImage' + PasswordChangeSuccess: + type: object + properties: + message: + type: string + description: Your password has been changed. Please login again. + required: + - message + PasswordResetSuccess: + type: object + properties: + message: + type: string + description: Your password has been reset. Please login again. + required: + - message + PatchedAccessManagementPlace: + type: object + description: Serializer for AccessManagementPlace model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 64 + configuration: + type: integer + expires_at: + type: string + format: date-time + nullable: true + monomode_testing_url: + type: string + readOnly: true + description: URL of the access management scanner for this place, in testing + mode. + monomode_url: + type: string + readOnly: true + description: URL of the access management scanner for this place. + PatchedCondition: + type: object + description: Serializer (read/write) for `Condition` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + maxLength: 128 + logical_operator: + allOf: + - $ref: '#/components/schemas/LogicalOperatorEnum' + description: |- + the logical operator used between multiple statements + + * `or` - OR + * `and` - AND + is_implicit: + type: boolean + title: Is implicit? + description: can store a combination of conditions as a single condition + PatchedConfirmationPageExtraTextActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionConfirmationPageExtraText` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ConfirmationPageExtraTextConfiguration' + PatchedEvent: + type: object + description: Serializer for Node model + properties: + id: + type: integer + readOnly: true + unit_id: + type: integer + name: + type: string + maxLength: 255 + status: + $ref: '#/components/schemas/EventStatusEnum' + moderation_status: + allOf: + - $ref: '#/components/schemas/ModerationStatusEnum' + readOnly: true + are_registrations_allowed: + type: boolean + readOnly: true + are_payments_allowed: + type: boolean + readOnly: true + registrations_start_date: + type: string + format: date-time + nullable: true + payments_start_date: + type: string + format: date-time + nullable: true + payments_end_date: + type: string + format: date-time + nullable: true + closed_start_date: + type: string + format: date + nullable: true + registrations_end_date: + type: string + format: date-time + nullable: true + start_date: + type: string + format: date-time + nullable: true + end_date: + type: string + format: date-time + nullable: true + custom_key: + type: string + maxLength: 128 + welcome_text: + type: string + description: Welcome text displayed on the Ticket Office event page. Some + restricted HTML markup is allowed, everything else is filtered out automatically. + frontend_url: + type: string + format: uri + description: External url provided by the organizer. I.e. their website + or social media page + maxLength: 200 + frontend_title: + type: string + description: Main name of the event shown to end users. I.e. shown on the + Ticket Office webpage + maxLength: 128 + frontend_organizers: + type: string + description: Name of the organizer, displayed on the Ticket Office event + page + maxLength: 128 + frontend_path: + type: string + description: Root of public path of the event url + maxLength: 128 + multiple_registration_per_login: + type: boolean + user_nickname_enabled: + type: boolean + user_registration_link_unique: + type: boolean + description_header_image: + type: integer + nullable: true + terms_of_service: + type: string + maxLength: 128 + location_text: + type: string + maxLength: 255 + location: + type: string + nullable: true + location_address: + type: string + readOnly: true + title: Location address (via reverse lookup) + is_public_visible: + type: boolean + is_unit_visible: + type: boolean + ticket_office_url: + type: string + readOnly: true + ticket_office_testing_url: + type: string + readOnly: true + is_basket_item_modification_allowed: + type: boolean + description: This field informs the front end on what actions should be + allowed or prevented, in the front end only. + is_in_lausanne: + type: boolean + description: if the event physically takes place in the city of Lausanne, + set this boolean so that taxes are calculated properly + is_status_public: + type: boolean + readOnly: true + PatchedFrontendBasket: + type: object + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + testing: + type: boolean + readOnly: true + created_by_id: + type: integer + readOnly: true + description: The id of the frontendlogin that created the basket. + billing_information_id: + type: integer + description: The id of the billing information linked to the basket. + total: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + readOnly: true + total_display: + type: string + readOnly: true + invoices: + type: array + items: + type: integer + readOnly: true + unikey: + type: string + description: Return a unique and checksummed-ish key + readOnly: true + status: + type: string + readOnly: true + registrations_count: + type: integer + readOnly: true + description: The number of root Selected Nodes linked to this basket. + invoices_total: + type: number + format: double + readOnly: true + description: Invoices total amount. + invoices_total_exceeds_basket_total: + type: boolean + readOnly: true + description: Whether the invoices total amount exceeds the basket total. + PatchedModuleAuthAnonymousLoginActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthAnonymousLogin` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthAnonymousLoginConfiguration' + PatchedModuleAuthThirdPartyTokenLoginActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthThirdPartyTokenLogin` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthThirdPartyTokenLoginConfiguration' + PatchedModuleAuthTrustedEmailActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleAuthTrustedEmail` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleAuthTrustedEmailConfiguration' + PatchedModuleCompletionEmailRegistrationCompletedActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionEmailRegistrationCompleted` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCompletedConfiguration' + PatchedModuleCompletionEmailRegistrationCreationActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionEmailRegistrationCreation` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionEmailRegistrationCreationConfiguration' + PatchedModuleCompletionPDFTicketActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionPDFTicket` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionPDFTicketConfiguration' + PatchedModuleCompletionRedirectActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleCompletionRedirect` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleCompletionRedirectConfiguration' + PatchedModulePaymentPayrexxActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModulePaymentPayrexx` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModulePaymentPayrexxConfiguration' + PatchedModulePaymentPointOfSaleActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModulePaymentPointOfSale` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModulePaymentPointOfSaleConfiguration' + PatchedModuleRegistrationAccessManagementActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleRegistrationOptions` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleRegistrationsAccessManagementConfiguration' + PatchedModuleRegistrationOptionsActiveModule: + type: object + description: Serializer for `ActiveModule` linked to `ModuleRegistrationOptions` + properties: + id: + type: integer + readOnly: true + event: + type: integer + readOnly: true + is_deleted: + type: boolean + config: + $ref: '#/components/schemas/ModuleRegistrationOptionsConfiguration' + PatchedNode: + type: object + description: Serializer for Node model + properties: + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: Local order between nodes that share the same parent + parent_id: + type: integer + internal_key: + type: string + maxLength: 128 + configuration_id: + type: integer + cart_configuration_id: + type: integer + children_ids: + type: array + items: + type: integer + readOnly: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeAccess: + type: object + description: Serializer (read/write) for `NodeAccess` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + label: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + is_accessible: + type: boolean + description: if True and user matches the conditions they should have access + to the node, if False and user matches the conditions they should not + have access to the node + PatchedNodeAvailability: + type: object + description: Serializer (read/write) for NodeAvailability model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + starts_at: + type: string + format: date-time + nullable: true + ends_at: + type: string + format: date-time + nullable: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeCartConfiguration: + type: object + description: Serializer (read/write) for NodeCartConfiguration model + properties: + id: + type: integer + readOnly: true + weight: + type: integer + maximum: 2147483647 + minimum: -2147483648 + range_min: + type: integer + maximum: 2147483647 + minimum: -2147483648 + title: Range minimum + range_max: + type: integer + maximum: 2147483647 + minimum: -2147483648 + title: Range maximum + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeConfiguration: + type: object + description: Serializer (read/write) for NodeConfiguration model + properties: + id: + type: integer + readOnly: true + description: + type: string + description: description for the node. Some restricted HTML markup is allowed, + everything else is filtered out automatically. + title: + type: string + maxLength: 128 + category: + $ref: '#/components/schemas/CategoryEnum' + image: + type: integer + nullable: true + image_style: {} + item_style: {} + display_price_difference: + type: boolean + display_limits_difference: + type: boolean + is_title_displayable: + type: boolean + is_image_displayable: + type: boolean + is_description_displayable: + type: boolean + is_tags_displayable: + type: boolean + starts_at: + type: string + format: date-time + nullable: true + description: Optional start datetime for this node. For display only. + ends_at: + type: string + format: date-time + nullable: true + description: Optional end datetime for this node. For display only. + is_subject_to_lausanne_tax: + type: boolean + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeExtraInfo: + type: object + description: Serializer (read/write) for `NodeExtraInfo` model + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + type: + $ref: '#/components/schemas/ModelFormLineType' + name: + type: string + maxLength: 256 + text: + type: string + maxLength: 256 + help_text: + type: string + maxLength: 512 + is_required: + type: boolean + choices_json: + type: string + nullable: true + major_json: + type: string + nullable: true + range_json: + type: string + nullable: true + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeExtraInfoGroup: + type: object + description: Serializer (read/write) for `NodeExtraInfoGroup` model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 256 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + is_inline: + type: boolean + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + extra_info_ids: + type: array + items: + type: integer + readOnly: true + is_required: + type: boolean + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + PatchedNodeLimit: + type: object + description: Serializer (read/write) for `NodeLimit` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + is_deleted: + type: boolean + key: + type: string + maxLength: 64 + label: + type: string + maxLength: 256 + maximum: + type: integer + maximum: 2147483647 + minimum: -2147483648 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + global_order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + PatchedNodePriceRule: + type: object + description: Serializer (read/write) for `NodePriceRule` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + global_order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + mode: + $ref: '#/components/schemas/ModeEnum' + value: + type: string + format: decimal + pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ + label: + type: string + maxLength: 256 + node_configuration_ids: + type: array + items: + type: integer + readOnly: true + condition_id: + type: integer + should_propagate: + type: boolean + description: does this rule apply on children of the node + PatchedNodeTag: + type: object + description: Serializer (read/write) for `NodeTag` model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + maxLength: 255 + node_configuration_id: + type: integer + PatchedPointOfSalePlaceReadOnly: + type: object + description: A serializer returning info for a point of sale place. You can + access only read methods as a frontend login and will only see some fields. + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + title: + type: string + readOnly: true + description: + type: string + readOnly: true + PatchedPolyTicketUser: + type: object + properties: + id: + type: integer + readOnly: true + username: + type: string + title: Username (email) + maxLength: 255 + first_name: + type: string + maxLength: 100 + last_name: + type: string + maxLength: 100 + email: + type: string + format: email + maxLength: 255 + personal_unit: + type: integer + nullable: true + is_active: + type: boolean + is_deleted: + type: boolean + PatchedPromotionCode: + type: object + description: Serializer for PromotionCode model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + description: name of the promotion that will be shown + maxLength: 128 + value: + type: string + description: value of the code that users will have to enter to get the + promotion + maxLength: 128 + PatchedSelectedNodeExtraInfo: + type: object + description: Serializer for `SelectedNodeExtraInfo` model + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + type: + allOf: + - $ref: '#/components/schemas/ModelFormLineType' + readOnly: true + name: + type: string + readOnly: true + text: + type: string + readOnly: true + help_text: + type: string + readOnly: true + is_required: + type: boolean + readOnly: true + choices_json: + type: string + readOnly: true + nullable: true + major_json: + type: string + readOnly: true + nullable: true + range_json: + type: string + readOnly: true + nullable: true + value: + type: string + description: value entered in the form + PatchedStatement: + type: object + description: Serializer for the Statement model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: order between statements of the same condition + condition: + type: integer + description: a statement is linked to a condition, to 're-use' statement, + use a condition instead of a statement + left_hand_operand: + oneOf: + - $ref: '#/components/schemas/LeftHandOperandEnum' + - $ref: '#/components/schemas/BlankEnum' + left_hand_value: + type: string + description: user defined value + maxLength: 128 + operator: + description: |- + with some left hand operands, the operator is unnecessary + + * `>` - Greater + * `>=` - Greater Or Equal + * `=` - Equal + * `!=` - Not Equal + * `<` - Less + * `<=` - Less Or Equal + * `exists` - Exists + * `contains` - Contains + * `is in` - Is In + oneOf: + - $ref: '#/components/schemas/OperatorEnum' + - $ref: '#/components/schemas/BlankEnum' + right_hand_value: + type: string + description: 'right hand operand: User defined value (this can be an empty + string with Operator.EXISTS)' + maxLength: 128 + condition_as_statement: + type: integer + nullable: true + description: use a condition as a statement (nested condition) + PatchedUnit: + type: object + description: Serializer for Unit model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 255 + description: + type: string + description: Description of the Unit. Some restricted HTML markup is allowed, + everything else is filtered out automatically. + iban: + type: string + maxLength: 255 + address: + type: string + payout_account_holder: + type: string + maxLength: 255 + email: + type: string + format: email + description: This field will be used as a main contact point for the unit, + e.g. for sending them statements, or to show to ticket buyers on how they + can contact the organizer. + maxLength: 255 + PatchedUnitMembership: + type: object + description: Serializer for UnitMembership model + properties: + id: + type: integer + readOnly: true + user: + type: integer + unit: + type: integer + role: + $ref: '#/components/schemas/UnitMembershipRoleEnum' + user_email: + type: string + format: email + readOnly: true + PatchedUploadedImage: + type: object + properties: + id: + type: integer + readOnly: true + file: + type: string + format: uri + uploaded_at: + type: string + format: date-time + readOnly: true + description: the datetime the image was uploaded at + event: + type: integer + nullable: true + description: the event associated to the image + frontend_login: + type: integer + nullable: true + description: the frontendlogin who uploaded the image + user: + type: integer + nullable: true + description: the user who uploaded the image + privacy_level: + $ref: '#/components/schemas/PrivacyLevelEnum' + PaymentIntent: + type: object + description: A serializer for Payment Intent. This serializer may contain invoice + or invoice_id depending on what the expand parameter is. + properties: + id: + type: integer + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + created_by: + type: integer + nullable: true + module_key: + type: string + maxLength: 255 + psp_id: + type: string + maxLength: 255 + invoice_id: + type: integer + description: Id of the related invoice + is_error: + type: boolean + is_cancelled: + type: boolean + error_message: + type: string + readOnly: true + description: Payment provider's error message if payment is refused + required: + - created_at + - error_message + - id + - invoice_id + - module_key + PaymentIntentRequestUpdate: + type: object + description: A serializer for Payment Intent Request Update containing the status + of the PSP + properties: + status: + allOf: + - $ref: '#/components/schemas/PaymentIntentRequestUpdateStatusEnum' + writeOnly: true + description: |- + Status of the payment service provider + + * `cancel` - Cancel + * `error` - Error + * `success` - Success + required: + - status + PaymentIntentRequestUpdateStatusEnum: + enum: + - cancel + - error + - success + type: string + description: |- + * `cancel` - Cancel + * `error` - Error + * `success` - Success + PaymentMethod: + type: object + description: A serializer returning info for a payment method + properties: + active_module_id: + type: integer + readOnly: true + description: The id of the payment method's active module + key: + type: string + readOnly: true + title: + type: string + readOnly: true + description: Title of the payment method + description: + type: string + readOnly: true + description: Description of the payment method + basket_total_amount: + type: number + format: double + readOnly: true + description: The total amount of the basket when using this payment method + (e.g. surcharges) + payment_module_price_extra: + type: number + format: double + readOnly: true + description: The difference between the total of the basket with the amount + added from the payment module and the total of the basket without + required: + - active_module_id + - basket_total_amount + - description + - key + - payment_module_price_extra + - title + PaymentStart: + type: object + description: A serializer with a basket as an input to start the payment and + with a payment link for the response + properties: + active_module_id: + type: integer + writeOnly: true + description: The ID of the payment method's active module you want to start + a payment with. If this is a free payment, the attribute is not required. + basket: + type: integer + writeOnly: true + description: The basket you want to start the payment for + link: + type: string + readOnly: true + description: If the chosen payment method requires an external redirect, + this attribute will contain the fully qualified URL to redirect the user + to + is_external_redirect: + type: boolean + readOnly: true + description: If true, the user must be redirected to the link. Otherwise, + the payment process requires more actions in the front end. + is_terms_of_service_accepted: + type: boolean + writeOnly: true + description: Must be true to validate a payment start. + payment_intent: + allOf: + - $ref: '#/components/schemas/PaymentIntent' + readOnly: true + required: + - basket + - is_external_redirect + - is_terms_of_service_accepted + - link + - payment_intent + PayrexxPayment: + type: object + description: Payment info related to the transaction + properties: + brand: + type: string + description: Brand used to make the payment. + required: + - brand + PayrexxTransaction: + type: object + description: |- + Transaction containing info for the webhook. + + referenceId can't be snake_case because the data is provided from Payrexx. + properties: + id: + type: integer + writeOnly: true + description: The ID of the transaction. + uuid: + type: string + writeOnly: true + description: The UUID of the transaction. + status: + type: string + writeOnly: true + description: The status of the transaction. + referenceId: + type: string + writeOnly: true + description: The reference containing PolyTicket env and Payment intent + id. + amount: + type: integer + writeOnly: true + description: The amount of the transaction in cents. + payment: + allOf: + - $ref: '#/components/schemas/PayrexxPayment' + writeOnly: true + description: The payment info related to the transaction. + required: + - amount + - id + - referenceId + - status + - uuid + PointOfSalePlace: + type: object + description: |- + A serializer read/write used only by authenticated users. It deals with the point of sale places resource. + This serializer is also used to display places as part of the module configuration view. + properties: + id: + type: integer + readOnly: true + configuration: + type: integer + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + title: + type: string + maxLength: 255 + description: + type: string + description: Description of a point of sale. Some restricted HTML markup + is allowed, everything else is filtered out automatically. + can_edit_registrations: + type: boolean + can_edit_users: + type: boolean + can_ignore_limits: + type: boolean + monomode_url: + type: string + readOnly: true + monomode_testing_url: + type: string + readOnly: true + required: + - configuration + - description + - id + - monomode_testing_url + - monomode_url + - order + - title + PointOfSalePlaceReadOnly: + type: object + description: A serializer returning info for a point of sale place. You can + access only read methods as a frontend login and will only see some fields. + properties: + id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + title: + type: string + readOnly: true + description: + type: string + readOnly: true + required: + - description + - id + - order + - title + PolyTicketUser: + type: object + properties: + id: + type: integer + readOnly: true + username: + type: string + title: Username (email) + maxLength: 255 + first_name: + type: string + maxLength: 100 + last_name: + type: string + maxLength: 100 + email: + type: string + format: email + maxLength: 255 + personal_unit: + type: integer + nullable: true + is_active: + type: boolean + is_deleted: + type: boolean + required: + - email + - id + - username + PrivacyLevelEnum: + enum: + - public + - event + - personal + type: string + description: |- + * `public` - Public + * `event` - Event + * `personal` - Personal + PromotionCode: + type: object + description: Serializer for PromotionCode model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + name: + type: string + description: name of the promotion that will be shown + maxLength: 128 + value: + type: string + description: value of the code that users will have to enter to get the + promotion + maxLength: 128 + required: + - event + - event_id + - id + - name + - value + Refund: + type: object + description: |- + Write only serializer used to provide `refund_amount` and `payment_intent` to the action `refund` on `InvoiceViewSet`. + A model serializer is used to give access to the targeted invoice, even though the fields are not part of the invoice model. + properties: + refund_amount: + type: string + format: decimal + writeOnly: true + description: Amount to be refunded on the invoice. + payment_intent_id: + type: integer + writeOnly: true + title: payment intent + description: The original payment intent linked to the invoice to be refunded. + required: + - payment_intent_id + - refund_amount + SelectedNode: + type: object + description: Serializer for SelectedNode model + properties: + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: Local order between nodes that share the same parent + basket: + type: integer + parent_id: + type: integer + configuration_id: + type: integer + is_article: + type: boolean + price: + type: number + format: double + readOnly: true + price_display: + type: string + readOnly: true + status: + $ref: '#/components/schemas/SelectedNodeStatusEnum' + required: + - basket + - configuration_id + - id + - order + - parent_id + - price + - price_display + SelectedNodeCreation: + type: object + description: |- + A serializer used specifically in the add-to-basket process. This serializer allows specifying all properties needed to add one item to the basket, including any extra info (groups). + This serializer only needs the pks of Nodes, not of NodeConfigurations, as we can determine them directly in this direction. + properties: + node_extra_info_groups: + type: array + items: + $ref: '#/components/schemas/AddToBasketNodeExtraInfoGroup' + node: + type: integer + children: + type: array + items: + $ref: '#/components/schemas/SelectedNodeCreation' + required: + - node + SelectedNodeDeletion: + type: object + description: A serializer used specifically in the remove-from-basket process. + This serializer takes only the id of the selected node to delete. The selected + node must currently be in the basket's registrations. + properties: + selected_node_id: + type: integer + required: + - selected_node_id + SelectedNodeExtraInfo: + type: object + description: Serializer for `SelectedNodeExtraInfo` model + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + readOnly: true + order: + type: integer + readOnly: true + type: + allOf: + - $ref: '#/components/schemas/ModelFormLineType' + readOnly: true + name: + type: string + readOnly: true + text: + type: string + readOnly: true + help_text: + type: string + readOnly: true + is_required: + type: boolean + readOnly: true + choices_json: + type: string + readOnly: true + nullable: true + major_json: + type: string + readOnly: true + nullable: true + range_json: + type: string + readOnly: true + nullable: true + value: + type: string + description: value entered in the form + required: + - choices_json + - group_id + - help_text + - id + - is_required + - major_json + - name + - order + - range_json + - text + - type + SelectedNodeExtraInfoGroup: + type: object + description: Serializer for `SelectedNodeExtraInfoGroup` model + properties: + id: + type: integer + readOnly: true + name: + type: string + readOnly: true + order: + type: integer + readOnly: true + is_inline: + type: boolean + readOnly: true + is_required: + type: boolean + readOnly: true + selected_configuration_id: + type: integer + readOnly: true + extra_info_ids: + type: array + items: + type: integer + required: + - extra_info_ids + - id + - is_inline + - is_required + - name + - order + - selected_configuration_id + SelectedNodeStatusEnum: + enum: + - new + - payment_in_progress + - validated + - edition_in_progress + - refunded + type: string + description: |- + * `new` - New + * `payment_in_progress` - Payment in progress + * `validated` - Validated + * `edition_in_progress` - Edition in progress + * `refunded` - Refunded + SelectedPromotionCode: + type: object + description: Serializer for SelectedPromotionCode model + properties: + id: + type: integer + readOnly: true + basket: + type: integer + promotion_code: + type: string + description: value of the code that users will have to enter to get the + promotion + writeOnly: true + promotion_code_id: + type: integer + nullable: true + readOnly: true + name: + type: string + readOnly: true + description: name of the promotion that will be shown + value: + type: string + readOnly: true + description: value of the code that users will have to enter to get the + promotion + required: + - basket + - id + - name + - promotion_code + - promotion_code_id + - value + Statement: + type: object + description: Serializer for the Statement model + properties: + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: order between statements of the same condition + condition: + type: integer + description: a statement is linked to a condition, to 're-use' statement, + use a condition instead of a statement + left_hand_operand: + oneOf: + - $ref: '#/components/schemas/LeftHandOperandEnum' + - $ref: '#/components/schemas/BlankEnum' + left_hand_value: + type: string + description: user defined value + maxLength: 128 + operator: + description: |- + with some left hand operands, the operator is unnecessary + + * `>` - Greater + * `>=` - Greater Or Equal + * `=` - Equal + * `!=` - Not Equal + * `<` - Less + * `<=` - Less Or Equal + * `exists` - Exists + * `contains` - Contains + * `is in` - Is In + oneOf: + - $ref: '#/components/schemas/OperatorEnum' + - $ref: '#/components/schemas/BlankEnum' + right_hand_value: + type: string + description: 'right hand operand: User defined value (this can be an empty + string with Operator.EXISTS)' + maxLength: 128 + condition_as_statement: + type: integer + nullable: true + description: use a condition as a statement (nested condition) + required: + - condition + - event + - event_id + - id + - order + TicketOfficeArticleCalculatedPrice: + type: object + properties: + price: + type: string + nullable: true + description: Retrieve the total article price from context. + readOnly: true + label: + type: string + nullable: true + description: Retrieve the total article label from context. + readOnly: true + required: + - label + - price + TicketOfficeInfos: + type: object + description: Serializer for TicketOffice infos, equivalent to NodeSerializer + for the BackOffice + properties: + id: + type: integer + readOnly: true + order: + type: integer + maximum: 2147483647 + minimum: -2147483648 + description: Local order between nodes that share the same parent + parent_id: + type: integer + internal_key: + type: string + maxLength: 128 + configuration: + allOf: + - $ref: '#/components/schemas/TicketOfficeNodeConfiguration' + readOnly: true + cart_configuration: + allOf: + - $ref: '#/components/schemas/NodeCartConfiguration' + readOnly: true + article_calculated_price: + allOf: + - $ref: '#/components/schemas/TicketOfficeArticleCalculatedPrice' + readOnly: true + option_calculated_price: + type: string + nullable: true + description: Retrieve the option article price from context. Return None + if node is not in calculated_prices. + readOnly: true + children: + type: array + items: + $ref: '#/components/schemas/TicketOfficeInfos' + required: + - article_calculated_price + - cart_configuration + - children + - configuration + - id + - option_calculated_price + - order + - parent_id + TicketOfficeNodeConfiguration: + type: object + description: |- + This is an extension of NodeConfigurationSerializer specific to the ticket office infos endpoint. + It adds a field for extra info groups and a filter applied to this field. + properties: + id: + type: integer + readOnly: true + description: + type: string + description: description for the node. Some restricted HTML markup is allowed, + everything else is filtered out automatically. + title: + type: string + maxLength: 128 + category: + $ref: '#/components/schemas/CategoryEnum' + image: + type: integer + nullable: true + image_style: {} + item_style: {} + display_price_difference: + type: boolean + display_limits_difference: + type: boolean + is_title_displayable: + type: boolean + is_image_displayable: + type: boolean + is_description_displayable: + type: boolean + is_tags_displayable: + type: boolean + starts_at: + type: string + format: date-time + nullable: true + description: Optional start datetime for this node. For display only. + ends_at: + type: string + format: date-time + nullable: true + description: Optional end datetime for this node. For display only. + is_subject_to_lausanne_tax: + type: boolean + event: + type: integer + writeOnly: true + event_id: + type: integer + readOnly: true + extra_info_groups: + type: array + items: + $ref: '#/components/schemas/TicketOfficeNodeExtraInfoGroup' + readOnly: true + limit: + allOf: + - $ref: '#/components/schemas/TicketOfficeNodeLimit' + readOnly: true + nullable: true + tags: + type: array + items: + $ref: '#/components/schemas/TicketOfficeNodeTag' + readOnly: true + required: + - event + - event_id + - extra_info_groups + - id + - limit + - tags + TicketOfficeNodeExtraInfo: + type: object + description: |- + Serializer (read/write) for `NodeExtraInfo` model + This is a copy of NodeExtraInfoSerializer to be used in the context of the ticket office infos endpoint. It will be used only in a read mode + properties: + id: + type: integer + readOnly: true + group_id: + type: integer + order: + type: integer + readOnly: true + type: + $ref: '#/components/schemas/ModelFormLineType' + name: + type: string + readOnly: true + text: + type: string + maxLength: 256 + help_text: + type: string + maxLength: 512 + is_required: + type: boolean + choices_json: + type: string + nullable: true + major_json: + type: string + nullable: true + range_json: + type: string + nullable: true + required: + - group_id + - id + - name + - order + - text + - type + TicketOfficeNodeExtraInfoGroup: + type: object + description: |- + Serializer (read/write) for `NodeExtraInfoGroup` model + This is a partial copy of NodeExtraInfoGroupSerializer (no reference to linked node configuration) to be used in the context of the ticket office infos endpoint. It will be used only in a read mode. + The field `configuration_id` is added manually in the configuration (hierarchical parent) serializer. This is done to avoid messing with nested serializer data since we are basically switching from an M2M in the backend to a foreign key in the data sent to the frontend. + properties: + id: + type: integer + readOnly: true + name: + type: string + readOnly: true + order: + type: integer + readOnly: true + is_required: + type: boolean + extra_infos: + type: array + items: + $ref: '#/components/schemas/TicketOfficeNodeExtraInfo' + readOnly: true + required: + - extra_infos + - id + - name + - order + TicketOfficeNodeLimit: + type: object + properties: + id: + type: integer + readOnly: true + key: + type: string + maxLength: 64 + label: + type: string + maxLength: 256 + maximum: + type: integer + maximum: 2147483647 + minimum: -2147483648 + available: + type: integer + readOnly: true + configuration_id: + type: integer + description: Usually a m2m field, this is specific to ticketoffice. + readOnly: true + required: + - available + - configuration_id + - id + - key + - label + - maximum + TicketOfficeNodeTag: + type: object + description: |- + Serializer (read only) for `NodeTag` model + This is a read only version of the `NodeTagSerializer`, destined to be used in `TicketOfficeInfosSerializer` through `TicketOfficeNodeConfigurationSerializer` + properties: + id: + type: integer + readOnly: true + name: + type: string + readOnly: true + configuration_id: + type: integer + readOnly: true + required: + - configuration_id + - id + - name + Unit: + type: object + description: Serializer for Unit model + properties: + id: + type: integer + readOnly: true + name: + type: string + maxLength: 255 + description: + type: string + description: Description of the Unit. Some restricted HTML markup is allowed, + everything else is filtered out automatically. + iban: + type: string + maxLength: 255 + address: + type: string + payout_account_holder: + type: string + maxLength: 255 + email: + type: string + format: email + description: This field will be used as a main contact point for the unit, + e.g. for sending them statements, or to show to ticket buyers on how they + can contact the organizer. + maxLength: 255 + required: + - description + - id + - name + UnitMemberShipCreationByEmail: + type: object + description: Serializer for the action create_by_email of UnitMemberShipViewSet + properties: + unit: + type: integer + user_email: + type: string + description: Email address of the user you want to add to the unit. + role: + allOf: + - $ref: '#/components/schemas/UnitMemberShipCreationByEmailRoleEnum' + description: |- + Desired role of the user in this unit. Defaults to member. + + * `owner` - owner + * `member` - member + required: + - unit + - user_email + UnitMemberShipCreationByEmailRoleEnum: + enum: + - owner + - member + type: string + description: |- + * `owner` - owner + * `member` - member + UnitMembership: + type: object + description: Serializer for UnitMembership model + properties: + id: + type: integer + readOnly: true + user: + type: integer + unit: + type: integer + role: + $ref: '#/components/schemas/UnitMembershipRoleEnum' + user_email: + type: string + format: email + readOnly: true + required: + - id + - unit + - user + - user_email + UnitMembershipRoleEnum: + enum: + - owner + - member + type: string + description: |- + * `owner` - Owner + * `member` - Member + UploadedImage: + type: object + properties: + id: + type: integer + readOnly: true + file: + type: string + format: uri + readOnly: true + uploaded_at: + type: string + format: date-time + readOnly: true + description: the datetime the image was uploaded at + event: + type: integer + nullable: true + description: the event associated to the image + frontend_login: + type: integer + nullable: true + description: the frontendlogin who uploaded the image + user: + type: integer + nullable: true + description: the user who uploaded the image + privacy_level: + $ref: '#/components/schemas/PrivacyLevelEnum' + required: + - file + - id + - uploaded_at + UserPasswordChange: + type: object + description: Serializer used for user password change requests. It verifies + the user has the correct current password for the account and validates the + new one. + properties: + current_password: + type: string + writeOnly: true + description: The current password associated with your account + new_password: + type: string + writeOnly: true + description: The new password to be used for your account + required: + - current_password + - new_password + UserPasswordReset: + type: object + description: Serializer used for user password reset. It should be used after + having made the request for a password reset. + properties: + user_id_b64: + type: string + writeOnly: true + description: The user's id encoded + password: + type: string + writeOnly: true + description: The new password + password_reset_token_b64: + type: string + writeOnly: true + description: The password reset token encoded given by the reset request + required: + - password + - password_reset_token_b64 + - user_id_b64 + UserPasswordResetRequest: + type: object + description: Serializer used for users password reset requests. If verifies + the email is associated with a valid account. + properties: + email: + type: string + format: email + writeOnly: true + description: The email associated with the account to reset the password + for. + required: + - email + UserRegistration: + type: object + description: Serializer for PolyTicketUser registration + properties: + id: + type: integer + readOnly: true + email: + type: string + format: email + maxLength: 255 + password: + type: string + writeOnly: true + description: The password associated with your account + first_name: + type: string + maxLength: 100 + last_name: + type: string + maxLength: 100 + captcha: + type: string + writeOnly: true + description: Captcha response token from the Recaptcha JS library challenge + captcha_bypass: + type: string + writeOnly: true + description: For testing purposes, permits to bypass captcha verification. + This field expects a shared secret. This feature is only usable on DEV + and INT environnments. + required: + - captcha + - email + - id + - password + UserVerification: + type: object + description: Serializer for PolyTicketUser verification + properties: + user_id_b64: + type: string + writeOnly: true + account_activation_token_b64: + type: string + writeOnly: true + required: + - account_activation_token_b64 + - user_id_b64 + ValidateThirdPartyTokenLogin: + type: object + description: Serializer used in the authentication of third party logins with + `third_party_token`. + properties: + active_module_id: + type: integer + writeOnly: true + description: The id of the active module linked to the third party token + login module. + third_party_token: + type: string + writeOnly: true + description: The token provided by third party for PolyTicket authentication. + required: + - active_module_id + - third_party_token + ValidateTrustedEmailLogin: + type: object + description: Serializer used to retrieve credentials from the TrustedEmailLogin + activation url. + properties: + active_module_id: + type: integer + writeOnly: true + testing: + type: boolean + writeOnly: true + default: false + login_pk_b64: + type: string + writeOnly: true + email_validation_token_b64: + type: string + writeOnly: true + required: + - active_module_id + - email_validation_token_b64 + - login_pk_b64 + VerificationError: + type: object + properties: + errors: + type: array + items: + type: string + description: List of errors encountered during account activation. + required: + - errors + VerificationSuccess: + type: object + properties: + message: + type: string + description: Message indicating account activation was successful. + required: + - message + Webhooks: + type: object + description: Webhook data containing a transaction + properties: + transaction: + allOf: + - $ref: '#/components/schemas/PayrexxTransaction' + description: The transaction of the webhook. + required: + - transaction + securitySchemes: + JWTAuth: + type: http + scheme: bearer + bearerFormat: JWT + basicAuth: + type: http + scheme: basic