openapi.yaml

swagger: "2.0"
info:
    title: LFX V2 - Survey Service
    description: Proxy service for ITX survey system
    version: "1.0"
host: localhost:8080
consumes:
    - application/json
    - application/xml
    - application/gob
produces:
    - application/json
    - application/xml
    - application/gob
paths:
    /surveys:
        post:
            tags:
                - survey
            summary: schedule_survey survey
            description: |-
                Create a scheduled survey for ITX project committee (proxies to ITX POST /surveys/schedule)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#schedule_survey
            parameters:
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: schedule_survey_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyScheduleSurveyRequestBody'
                    required:
                        - committee_uid
            responses:
                "201":
                    description: Created response.
                    schema:
                        $ref: '#/definitions/SurveyScheduleResult'
                        required:
                            - uid
                            - survey_status
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}:
        get:
            tags:
                - survey
            summary: get_survey survey
            description: |-
                Get survey details (proxies to ITX GET /v2/surveys/{survey_uid})

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#get_survey
            parameters:
                - name: project_uid
                  in: query
                  description: Optional LFX Project UID (V2) to filter survey data
                  required: false
                  type: string
                - name: project_uids
                  in: query
                  description: Optional comma-delimited list of LFX Project UIDs (V2). Should not be combined with project_uid
                  required: false
                  type: string
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "200":
                    description: OK response.
                    schema:
                        $ref: '#/definitions/SurveyScheduleResult'
                        required:
                            - uid
                            - survey_status
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
        put:
            tags:
                - survey
            summary: update_survey survey
            description: |-
                Update survey (proxies to ITX PUT /v2/surveys/{survey_uid}). Only allowed when status is 'disabled'

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#update_survey
            parameters:
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: update_survey_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyUpdateSurveyRequestBody'
            responses:
                "200":
                    description: OK response.
                    schema:
                        $ref: '#/definitions/SurveyScheduleResult'
                        required:
                            - uid
                            - survey_status
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
        delete:
            tags:
                - survey
            summary: delete_survey survey
            description: |-
                Delete survey (proxies to ITX DELETE /v2/surveys/{survey_uid}). Only allowed when status is 'disabled'

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#delete_survey
            parameters:
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/bulk_resend:
        post:
            tags:
                - survey
            summary: bulk_resend_survey survey
            description: |-
                Bulk resend survey emails to select recipients (proxies to ITX POST /v2/surveys/{survey_uid}/bulk_resend)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#bulk_resend_survey
            parameters:
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: bulk_resend_survey_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyBulkResendSurveyRequestBody'
                    required:
                        - recipient_ids
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/preview_send:
        get:
            tags:
                - survey
            summary: preview_send_survey survey
            description: |-
                Preview which recipients, committees, and projects would be affected by a resend (proxies to ITX GET /v2/surveys/{survey_uid}/preview_send)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#preview_send_survey
            parameters:
                - name: committee_uid
                  in: query
                  description: Optional committee UID to filter preview
                  required: false
                  type: string
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "200":
                    description: OK response.
                    schema:
                        $ref: '#/definitions/PreviewSendResult'
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/recipient_group:
        delete:
            tags:
                - survey
            summary: delete_recipient_group survey
            description: |-
                Remove a recipient group (committee, project, or foundation) from survey and recalculate statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/recipient_group)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#delete_recipient_group
            parameters:
                - name: committee_uid
                  in: query
                  description: Committee UID to remove (indicates specific committee in project)
                  required: false
                  type: string
                - name: project_uid
                  in: query
                  description: Project UID to remove (all removals are attached to a project)
                  required: false
                  type: string
                - name: foundation_id
                  in: query
                  description: Foundation ID (indicates project_uid references a foundation and all subprojects should be removed)
                  required: false
                  type: string
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/responses/{response_id}:
        delete:
            tags:
                - survey
            summary: delete_survey_response survey
            description: |-
                Delete survey response - removes recipient from survey and recalculates statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/responses/{response_id})

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#delete_survey_response
            parameters:
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: response_id
                  in: path
                  description: Response identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/responses/{response_id}/resend:
        post:
            tags:
                - survey
            summary: resend_survey_response survey
            description: |-
                Resend survey email to a specific user (proxies to ITX POST /v2/surveys/{survey_uid}/responses/{response_id}/resend)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#resend_survey_response
            parameters:
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: response_id
                  in: path
                  description: Response identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/{survey_uid}/send_missing_recipients:
        post:
            tags:
                - survey
            summary: send_missing_recipients survey
            description: |-
                Send survey emails to committee members who haven't received it (proxies to ITX POST /v2/surveys/{survey_uid}/send_missing_recipients)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#send_missing_recipients
            parameters:
                - name: committee_uid
                  in: query
                  description: Optional committee UID to resync only that committee
                  required: false
                  type: string
                - name: survey_uid
                  in: path
                  description: Survey identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
                "503":
                    description: Service Unavailable response.
                    schema:
                        $ref: '#/definitions/ServiceUnavailableError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/exclusion:
        post:
            tags:
                - survey
            summary: create_exclusion survey
            description: |-
                Create a survey or global exclusion (proxies to ITX POST /v2/surveys/exclusion)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#create_exclusion
            parameters:
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: create_exclusion_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyCreateExclusionRequestBody'
            responses:
                "201":
                    description: Created response.
                    schema:
                        $ref: '#/definitions/ExclusionResult'
                        required:
                            - uid
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
        delete:
            tags:
                - survey
            summary: delete_exclusion survey
            description: |-
                Delete a survey or global exclusion (proxies to ITX DELETE /v2/surveys/exclusion)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#delete_exclusion
            parameters:
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: delete_exclusion_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyDeleteExclusionRequestBody'
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/exclusion/{exclusion_id}:
        get:
            tags:
                - survey
            summary: get_exclusion survey
            description: |-
                Get exclusion by ID (proxies to ITX GET /v2/surveys/exclusion/{exclusion_id})

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#get_exclusion
            parameters:
                - name: exclusion_id
                  in: path
                  description: Exclusion identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "200":
                    description: OK response.
                    schema:
                        $ref: '#/definitions/ExtendedExclusionResult'
                        required:
                            - uid
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "404":
                    description: Not Found response.
                    schema:
                        $ref: '#/definitions/NotFoundError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
        delete:
            tags:
                - survey
            summary: delete_exclusion_by_id survey
            description: |-
                Delete exclusion by ID (proxies to ITX DELETE /v2/surveys/exclusion/{exclusion_id})

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#delete_exclusion_by_id
            parameters:
                - name: exclusion_id
                  in: path
                  description: Exclusion identifier
                  required: true
                  type: string
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
            responses:
                "204":
                    description: No Content response.
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
    /surveys/validate_email:
        post:
            tags:
                - survey
            summary: validate_email survey
            description: |-
                Validate email template body and subject (proxies to ITX POST /v2/surveys/validate_email)

                **Required security scopes for jwt**:
                  * `manage:projects`
                  * `manage:surveys`
            operationId: survey#validate_email
            parameters:
                - name: Authorization
                  in: header
                  description: JWT token
                  required: false
                  type: string
                - name: validate_email_request_body
                  in: body
                  required: true
                  schema:
                    $ref: '#/definitions/SurveyValidateEmailRequestBody'
            responses:
                "200":
                    description: OK response.
                    schema:
                        $ref: '#/definitions/ValidateEmailResult'
                        required:
                            - body
                            - subject
                "400":
                    description: Bad Request response.
                    schema:
                        $ref: '#/definitions/BadRequestError'
                        required:
                            - code
                            - message
                "401":
                    description: Unauthorized response.
                    schema:
                        $ref: '#/definitions/UnauthorizedError'
                        required:
                            - code
                            - message
                "403":
                    description: Forbidden response.
                    schema:
                        $ref: '#/definitions/ForbiddenError'
                        required:
                            - code
                            - message
                "500":
                    description: Internal Server Error response.
                    schema:
                        $ref: '#/definitions/InternalServerError'
                        required:
                            - code
                            - message
            schemes:
                - http
            security:
                - jwt_header_Authorization: []
definitions:
    BadRequestError:
        title: BadRequestError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Dolor culpa.
            message:
                type: string
                description: Error message
                example: Qui ut cumque accusamus velit fugiat numquam.
        description: Bad request
        example:
            code: Aut sapiente.
            message: Nam voluptate accusantium voluptatem.
        required:
            - code
            - message
    ExcludedCommittee:
        title: ExcludedCommittee
        type: object
        properties:
            committee_category:
                type: string
                description: Committee category
                example: Technical Steering Committee
                enum:
                    - Legal Committee
                    - Finance Committee
                    - Special Interest Group
                    - Board
                    - Technical Oversight Committee/Technical Advisory Committee
                    - Technical Steering Committee
            committee_name:
                type: string
                description: Committee name
                example: Technical Steering Committee
            committee_uid:
                type: string
                description: Committee UID
                example: qa1e8536-a985-4cf5-b981-a170927a1d11
            project_name:
                type: string
                description: Project name
                example: Kubernetes
            project_uid:
                type: string
                description: Project UID
                example: 003170000123XHTAA2
        description: Committee information for preview send
        example:
            committee_category: Technical Steering Committee
            committee_name: Technical Steering Committee
            committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
            project_name: Kubernetes
            project_uid: 003170000123XHTAA2
        required:
            - project_uid
            - project_name
            - committee_uid
            - committee_name
            - committee_category
    ExclusionResult:
        title: ExclusionResult
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID
                example: Ut sapiente iure.
            email:
                type: string
                description: Survey responder's email
                example: test@email.com
            global_exclusion:
                type: string
                description: Global exclusion flag
                example: Ipsam nam ut officiis qui sunt.
            survey_uid:
                type: string
                description: Survey UID
                example: Eum molestias quis occaecati repellendus.
            uid:
                type: string
                description: Exclusion unique identifier
                example: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e
            user_id:
                type: string
                description: Recipient's user ID
                example: Dicta rerum sapiente deserunt.
        example:
            committee_uid: Cupiditate ut labore doloremque.
            email: test@email.com
            global_exclusion: Cupiditate voluptatum et velit quaerat.
            survey_uid: Molestiae aliquam quam.
            uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e
            user_id: Sunt deleniti praesentium quaerat qui cum neque.
        required:
            - uid
    ExclusionUser:
        title: ExclusionUser
        type: object
        properties:
            emails:
                type: array
                items:
                    $ref: '#/definitions/UserEmail'
                description: User emails
                example:
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
            id:
                type: string
                description: User ID
                example: Animi quas.
            username:
                type: string
                description: Username
                example: Ipsa quia exercitationem ut eos rerum.
        description: User information for an exclusion
        example:
            emails:
                - email_address: Excepturi totam et qui vel.
                  id: Officiis officiis quasi possimus aut eum eum.
                  is_primary: false
                - email_address: Excepturi totam et qui vel.
                  id: Officiis officiis quasi possimus aut eum eum.
                  is_primary: false
                - email_address: Excepturi totam et qui vel.
                  id: Officiis officiis quasi possimus aut eum eum.
                  is_primary: false
                - email_address: Excepturi totam et qui vel.
                  id: Officiis officiis quasi possimus aut eum eum.
                  is_primary: false
            id: Omnis occaecati atque numquam.
            username: Ut maiores et porro.
    ExtendedExclusionResult:
        title: ExtendedExclusionResult
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID
                example: Molestias et voluptate nulla voluptatem.
            email:
                type: string
                description: Survey responder's email
                example: test@email.com
            global_exclusion:
                type: string
                description: Global exclusion flag
                example: Sequi at unde quia est et quo.
            survey_uid:
                type: string
                description: Survey UID
                example: Minima molestiae ut suscipit perspiciatis cupiditate harum.
            uid:
                type: string
                description: Exclusion unique identifier
                example: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e
            user:
                $ref: '#/definitions/ExclusionUser'
            user_id:
                type: string
                description: Recipient's user ID
                example: Et dicta ullam fuga in hic possimus.
        example:
            committee_uid: Molestiae nobis ducimus hic est.
            email: test@email.com
            global_exclusion: Quas ut et magni repellendus ea.
            survey_uid: Explicabo tempore nostrum autem et.
            uid: 5f8b3c4d-9a2e-4f1b-8c7d-6e5a4b3c2d1e
            user:
                emails:
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                    - email_address: Excepturi totam et qui vel.
                      id: Officiis officiis quasi possimus aut eum eum.
                      is_primary: false
                id: Rerum autem molestias necessitatibus dolores fuga.
                username: Ab vitae qui ad tenetur vitae.
            user_id: Odio aut.
        required:
            - uid
    ForbiddenError:
        title: ForbiddenError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Nam molestiae.
            message:
                type: string
                description: Error message
                example: Ipsam eius nisi consequatur.
        description: Forbidden
        example:
            code: Molestias saepe ab laboriosam.
            message: Eius dolor deserunt debitis.
        required:
            - code
            - message
    ITXPreviewRecipient:
        title: ITXPreviewRecipient
        type: object
        properties:
            email:
                type: string
                description: Email address
                example: john.doe@example.com
                format: email
            first_name:
                type: string
                description: User first name
                example: John
            last_name:
                type: string
                description: User last name
                example: Doe
            name:
                type: string
                description: User full name
                example: John Doe
            role:
                type: string
                description: Role in committee
                example: Voting Rep
                enum:
                    - Chair
                    - Voting Rep
                    - Member
            user_id:
                type: string
                description: LF user ID
                example: 005f1000009RbC4AAK
            username:
                type: string
                description: Linux Foundation ID
                example: jdoe
        description: Recipient information for preview send
        example:
            email: john.doe@example.com
            first_name: John
            last_name: Doe
            name: John Doe
            role: Voting Rep
            user_id: 005f1000009RbC4AAK
            username: jdoe
        required:
            - user_id
            - email
    InternalServerError:
        title: InternalServerError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Voluptatem perspiciatis omnis.
            message:
                type: string
                description: Error message
                example: Dicta dicta nesciunt quas.
        description: Internal server error
        example:
            code: Sequi consequuntur rerum omnis quos aut.
            message: Laborum quas corrupti voluptatum ea.
        required:
            - code
            - message
    LFXProject:
        title: LFXProject
        type: object
        properties:
            id:
                type: string
                description: Project ID
                example: 003170000123XHTAA2
            logo_url:
                type: string
                description: Project logo URL
                example: Fugit officiis cum rerum.
            name:
                type: string
                description: Project name
                example: Express JS
            slug:
                type: string
                description: Project slug
                example: express-gateway
            status:
                type: string
                description: Project status/stage
                example: Active
                enum:
                    - Formation - Exploratory
                    - Formation - Engaged
                    - Active
                    - Archived
                    - Formation - On Hold
                    - Formation - Disengaged
                    - Formation - Confidential
                    - Prospect
        description: LFX Project information
        example:
            id: 003170000123XHTAA2
            logo_url: Dignissimos quo quibusdam non doloremque.
            name: Express JS
            slug: express-gateway
            status: Active
        required:
            - id
            - name
            - slug
            - status
    NotFoundError:
        title: NotFoundError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Nostrum temporibus possimus.
            message:
                type: string
                description: Error message
                example: Quas non.
        description: Not found
        example:
            code: Magnam optio.
            message: Earum qui eos id.
        required:
            - code
            - message
    PreviewSendResult:
        title: PreviewSendResult
        type: object
        properties:
            affected_committees:
                type: array
                items:
                    $ref: '#/definitions/ExcludedCommittee'
                description: List of affected committees
                example:
                    - committee_category: Technical Steering Committee
                      committee_name: Technical Steering Committee
                      committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      project_name: Kubernetes
                      project_uid: 003170000123XHTAA2
                    - committee_category: Technical Steering Committee
                      committee_name: Technical Steering Committee
                      committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      project_name: Kubernetes
                      project_uid: 003170000123XHTAA2
                    - committee_category: Technical Steering Committee
                      committee_name: Technical Steering Committee
                      committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      project_name: Kubernetes
                      project_uid: 003170000123XHTAA2
            affected_projects:
                type: array
                items:
                    $ref: '#/definitions/LFXProject'
                description: List of affected projects
                example:
                    - id: 003170000123XHTAA2
                      logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                      name: Express JS
                      slug: express-gateway
                      status: Active
                    - id: 003170000123XHTAA2
                      logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                      name: Express JS
                      slug: express-gateway
                      status: Active
                    - id: 003170000123XHTAA2
                      logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                      name: Express JS
                      slug: express-gateway
                      status: Active
            affected_recipients:
                type: array
                items:
                    $ref: '#/definitions/ITXPreviewRecipient'
                description: List of affected recipients
                example:
                    - email: john.doe@example.com
                      first_name: John
                      last_name: Doe
                      name: John Doe
                      role: Voting Rep
                      user_id: 005f1000009RbC4AAK
                      username: jdoe
                    - email: john.doe@example.com
                      first_name: John
                      last_name: Doe
                      name: John Doe
                      role: Voting Rep
                      user_id: 005f1000009RbC4AAK
                      username: jdoe
        example:
            affected_committees:
                - committee_category: Technical Steering Committee
                  committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  project_name: Kubernetes
                  project_uid: 003170000123XHTAA2
                - committee_category: Technical Steering Committee
                  committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  project_name: Kubernetes
                  project_uid: 003170000123XHTAA2
            affected_projects:
                - id: 003170000123XHTAA2
                  logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                  name: Express JS
                  slug: express-gateway
                  status: Active
                - id: 003170000123XHTAA2
                  logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                  name: Express JS
                  slug: express-gateway
                  status: Active
                - id: 003170000123XHTAA2
                  logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                  name: Express JS
                  slug: express-gateway
                  status: Active
                - id: 003170000123XHTAA2
                  logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
                  name: Express JS
                  slug: express-gateway
                  status: Active
            affected_recipients:
                - email: john.doe@example.com
                  first_name: John
                  last_name: Doe
                  name: John Doe
                  role: Voting Rep
                  user_id: 005f1000009RbC4AAK
                  username: jdoe
                - email: john.doe@example.com
                  first_name: John
                  last_name: Doe
                  name: John Doe
                  role: Voting Rep
                  user_id: 005f1000009RbC4AAK
                  username: jdoe
                - email: john.doe@example.com
                  first_name: John
                  last_name: Doe
                  name: John Doe
                  role: Voting Rep
                  user_id: 005f1000009RbC4AAK
                  username: jdoe
                - email: john.doe@example.com
                  first_name: John
                  last_name: Doe
                  name: John Doe
                  role: Voting Rep
                  user_id: 005f1000009RbC4AAK
                  username: jdoe
    ServiceUnavailableError:
        title: ServiceUnavailableError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Quis dolores ut et.
            message:
                type: string
                description: Error message
                example: Aspernatur praesentium est impedit ut ut quaerat.
        description: Service unavailable
        example:
            code: Nisi perspiciatis.
            message: Delectus et consectetur illum unde autem omnis.
        required:
            - code
            - message
    SurveyBulkResendSurveyRequestBody:
        title: SurveyBulkResendSurveyRequestBody
        type: object
        properties:
            recipient_ids:
                type: array
                items:
                    type: string
                    example: Inventore perferendis.
                description: Array of recipient IDs to resend survey emails to
                example:
                    - cba14f40-1636-11ec-9621-0242ac130002
                    - cba14f40-1636-11ec-9621-0242ac130003
        example:
            recipient_ids:
                - cba14f40-1636-11ec-9621-0242ac130002
                - cba14f40-1636-11ec-9621-0242ac130003
        required:
            - recipient_ids
    SurveyCommittee:
        title: SurveyCommittee
        type: object
        properties:
            committee_name:
                type: string
                description: Committee name
                example: Technical Steering Committee
            committee_uid:
                type: string
                description: Committee UID
                example: qa1e8536-a985-4cf5-b981-a170927a1d11
            nps_value:
                type: number
                description: NPS value for this committee
                example: 0.2719950762101171
                format: double
            project_name:
                type: string
                description: Project name
                example: Kubernetes
            project_uid:
                type: string
                description: Project UID
                example: qa1e8536-a985-4cf5-b981-a170927a1d11
            survey_url:
                type: string
                description: Survey URL for this committee
                example: https://surveymonkey.com/r/abc123
            total_recipients:
                type: integer
                description: Total recipients for this committee
                example: 8360805817855735579
                format: int64
            total_responses:
                type: integer
                description: Total responses for this committee
                example: 2317337672288157344
                format: int64
        description: Survey committee details
        example:
            committee_name: Technical Steering Committee
            committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
            nps_value: 0.7274350005223461
            project_name: Kubernetes
            project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
            survey_url: https://surveymonkey.com/r/abc123
            total_recipients: 898235292458345736
            total_responses: 6716164380180638854
    SurveyCreateExclusionRequestBody:
        title: SurveyCreateExclusionRequestBody
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID for survey-specific exclusion
                example: Quasi aut ad hic ut voluptas dolorem.
            email:
                type: string
                description: Survey responder's email
                example: Ea molestias et ipsam.
            global_exclusion:
                type: string
                description: Global exclusion flag
                example: Deleniti officia numquam expedita.
            survey_uid:
                type: string
                description: Survey UID for survey-specific exclusion
                example: Officia suscipit in fugiat.
            user_id:
                type: string
                description: Recipient's user ID
                example: Distinctio modi ratione deleniti.
        example:
            committee_uid: Ratione et.
            email: Et quidem sunt.
            global_exclusion: Sit delectus illum iure.
            survey_uid: Molestiae ut suscipit nulla.
            user_id: Ab eveniet et qui in odio doloribus.
    SurveyDeleteExclusionRequestBody:
        title: SurveyDeleteExclusionRequestBody
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID for survey-specific exclusion
                example: Ut quo reprehenderit.
            email:
                type: string
                description: Survey responder's email
                example: Beatae cum exercitationem autem natus quae.
            global_exclusion:
                type: string
                description: Global exclusion flag
                example: Vel rem vel id nobis optio fugit.
            survey_uid:
                type: string
                description: Survey UID for survey-specific exclusion
                example: Cumque ad ut.
            user_id:
                type: string
                description: Recipient's user ID
                example: Rerum pariatur.
        example:
            committee_uid: Modi quisquam inventore vitae sed beatae.
            email: Mollitia et reprehenderit rerum.
            global_exclusion: Esse dolorem.
            survey_uid: Itaque saepe.
            user_id: Dolorem velit sit et.
    SurveyScheduleResult:
        title: SurveyScheduleResult
        type: object
        properties:
            committee_category:
                type: string
                description: Committee category
                example: Optio laudantium aliquam et sit vel ea.
            committee_voting_enabled:
                type: boolean
                description: Committee voting enabled
                example: true
            committees:
                type: array
                items:
                    $ref: '#/definitions/SurveyCommittee'
                description: Survey committees
                example:
                    - committee_name: Technical Steering Committee
                      committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      nps_value: 0.6266969501277094
                      project_name: Kubernetes
                      project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      survey_url: https://surveymonkey.com/r/abc123
                      total_recipients: 256525687450027157
                      total_responses: 8506409821911103766
                    - committee_name: Technical Steering Committee
                      committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      nps_value: 0.6266969501277094
                      project_name: Kubernetes
                      project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                      survey_url: https://surveymonkey.com/r/abc123
                      total_recipients: 256525687450027157
                      total_responses: 8506409821911103766
            created_at:
                type: string
                description: Creation timestamp
                example: "1991-06-14T04:12:59Z"
                format: date-time
            creator_id:
                type: string
                description: Creator's user ID
                example: Quaerat dolor.
            creator_name:
                type: string
                description: Creator's full name
                example: Facilis reiciendis et quos excepturi saepe voluptatum.
            creator_username:
                type: string
                description: Creator's username
                example: Quisquam et qui.
            email_body:
                type: string
                description: Email body HTML
                example: Et tempore ea ut officiis omnis voluptate.
            email_body_text:
                type: string
                description: Email body plain text
                example: Repellat earum non ut id asperiores hic.
            email_subject:
                type: string
                description: Email subject line
                example: In impedit repellat.
            is_nps_survey:
                type: boolean
                description: Whether this is an NPS survey
                example: true
            is_project_survey:
                type: boolean
                description: Whether project-level or global-level survey
                example: true
            last_modified_at:
                type: string
                description: Last modification timestamp
                example: "1996-03-05T09:04:50Z"
                format: date-time
            last_modified_by:
                type: string
                description: User ID of last modifier
                example: Facere sit quaerat pariatur.
            latest_automated_reminder_sent_at:
                type: string
                description: Latest automated reminder sent date
                example: "1991-08-11T14:21:28Z"
                format: date-time
            next_automated_reminder_at:
                type: string
                description: Next automated reminder date
                example: "2012-10-19T00:51:29Z"
                format: date-time
            nps_value:
                type: number
                description: NPS value
                example: 0.06048709593621433
                format: double
            num_automated_reminders_sent:
                type: integer
                description: Number of automated reminders sent
                example: 7423717503328996703
                format: int64
            num_automated_reminders_to_send:
                type: integer
                description: Number of automated reminders to send
                example: 4792105792390663775
                format: int64
            num_detractors:
                type: integer
                description: Number of detractors
                example: 3721412613282556941
                format: int64
            num_passives:
                type: integer
                description: Number of passives
                example: 630602705079431779
                format: int64
            num_promoters:
                type: integer
                description: Number of promoters
                example: 9144982420120398791
                format: int64
            response_status:
                type: string
                description: Response status
                example: scheduled
                enum:
                    - scheduled
                    - open
                    - closed
            send_immediately:
                type: boolean
                description: Whether survey is sent immediately
                example: false
            stage_filter:
                type: string
                description: Project stage filter
                example: Esse perferendis.
            survey_cutoff_date:
                type: string
                description: Survey cutoff date
                example: "2008-06-23T19:55:46Z"
                format: date-time
            survey_monkey_id:
                type: string
                description: SurveyMonkey survey ID
                example: In porro aspernatur.
            survey_reminder_rate_days:
                type: integer
                description: Days between reminder emails
                example: 5932690482610108701
                format: int64
            survey_send_date:
                type: string
                description: Survey send date
                example: "1986-11-11T13:54:53Z"
                format: date-time
            survey_status:
                type: string
                description: Survey status
                example: scheduled
                enum:
                    - scheduled
                    - sending
                    - sent
                    - cancelled
            survey_title:
                type: string
                description: Survey title
                example: Quibusdam minima ut quis dolore incidunt velit.
            survey_url:
                type: string
                description: Survey URL
                example: Ut excepturi velit expedita placeat.
            total_bounced_emails:
                type: integer
                description: Number of bounced emails
                example: 5714015393000907159
                format: int64
            total_recipients:
                type: integer
                description: Total number of recipients
                example: 5049480956996120320
                format: int64
            total_responses:
                type: integer
                description: Total number of responses
                example: 949381826978715625
                format: int64
            uid:
                type: string
                description: Survey unique identifier
                example: 4e8165a9-9b29-4506-b093-ab0a4aae9b84
        example:
            committee_category: Vitae et nesciunt culpa cupiditate.
            committee_voting_enabled: true
            committees:
                - committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  nps_value: 0.6266969501277094
                  project_name: Kubernetes
                  project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  survey_url: https://surveymonkey.com/r/abc123
                  total_recipients: 256525687450027157
                  total_responses: 8506409821911103766
                - committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  nps_value: 0.6266969501277094
                  project_name: Kubernetes
                  project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  survey_url: https://surveymonkey.com/r/abc123
                  total_recipients: 256525687450027157
                  total_responses: 8506409821911103766
                - committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  nps_value: 0.6266969501277094
                  project_name: Kubernetes
                  project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  survey_url: https://surveymonkey.com/r/abc123
                  total_recipients: 256525687450027157
                  total_responses: 8506409821911103766
                - committee_name: Technical Steering Committee
                  committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  nps_value: 0.6266969501277094
                  project_name: Kubernetes
                  project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
                  survey_url: https://surveymonkey.com/r/abc123
                  total_recipients: 256525687450027157
                  total_responses: 8506409821911103766
            created_at: "1991-01-24T03:13:13Z"
            creator_id: Rerum nostrum provident nihil quam quaerat.
            creator_name: Voluptate eius nihil ut ut quos.
            creator_username: Ipsam et nulla.
            email_body: Qui dolores.
            email_body_text: Porro dicta ipsam cumque.
            email_subject: Nisi blanditiis veniam voluptatem.
            is_nps_survey: false
            is_project_survey: false
            last_modified_at: "2014-03-04T22:25:37Z"
            last_modified_by: Id quod.
            latest_automated_reminder_sent_at: "2013-01-23T09:18:20Z"
            next_automated_reminder_at: "2000-04-24T23:39:00Z"
            nps_value: 0.8567202275814672
            num_automated_reminders_sent: 4849997741128336544
            num_automated_reminders_to_send: 8250981986975932702
            num_detractors: 5455946721173509686
            num_passives: 6396227727816532693
            num_promoters: 2633350034400695879
            response_status: scheduled
            send_immediately: true
            stage_filter: Facilis aut doloribus perspiciatis expedita ipsam aut.
            survey_cutoff_date: "1985-04-15T13:02:36Z"
            survey_monkey_id: Minus magnam et.
            survey_reminder_rate_days: 815636587156196874
            survey_send_date: "2009-12-20T16:20:59Z"
            survey_status: scheduled
            survey_title: Ipsum fugiat.
            survey_url: Nemo consequatur nihil aut neque.
            total_bounced_emails: 2286647374539067270
            total_recipients: 1356697113763045090
            total_responses: 3035120764609076041
            uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84
        required:
            - uid
            - survey_status
    SurveyScheduleSurveyRequestBody:
        title: SurveyScheduleSurveyRequestBody
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID to send survey to
                example: qa1e8536-a985-4cf5-b981-a170927a1d11
            committee_voting_enabled:
                type: boolean
                description: Whether committee voting is enabled
                example: true
            creator_id:
                type: string
                description: Creator's user ID
                example: Optio aut.
            creator_name:
                type: string
                description: Creator's full name
                example: Corporis magni nobis est neque sed ut.
            creator_username:
                type: string
                description: Creator's username
                example: Sed possimus.
            email_body:
                type: string
                description: Email body HTML content
                example: Aut earum odit dolorum.
            email_body_text:
                type: string
                description: Email body plain text content
                example: Commodi fugiat.
            email_subject:
                type: string
                description: Email subject line
                example: Harum sunt quasi ea aut id.
            is_project_survey:
                type: boolean
                description: Whether the survey is project-level (true) or global-level (false)
                example: true
            send_immediately:
                type: boolean
                description: Send immediately (true) or schedule for later (false)
                example: false
            stage_filter:
                type: string
                description: Project stage filter for global surveys
                example: Explicabo quidem perspiciatis quidem.
            survey_cutoff_date:
                type: string
                description: Survey cutoff/end date (RFC3339 format)
                example: Rerum voluptate doloribus praesentium qui explicabo quia.
            survey_monkey_id:
                type: string
                description: SurveyMonkey survey ID
                example: Est minus eveniet perspiciatis.
            survey_reminder_rate_days:
                type: integer
                description: Days between automatic reminder emails (0 = no reminders)
                example: 3101412374997671411
                format: int64
            survey_send_date:
                type: string
                description: Date to send the survey (RFC3339 format)
                example: Quia hic.
            survey_title:
                type: string
                description: Survey title
                example: Natus pariatur dolor quae iure accusantium mollitia.
        example:
            committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
            committee_voting_enabled: true
            creator_id: Beatae qui est.
            creator_name: Est maiores quibusdam.
            creator_username: Et voluptas non vel est.
            email_body: Eveniet corporis at aliquam eligendi.
            email_body_text: Et sed nulla unde nihil dolor.
            email_subject: Quia sunt vel quidem.
            is_project_survey: false
            send_immediately: false
            stage_filter: Ipsam dignissimos beatae dolor aliquam alias.
            survey_cutoff_date: Omnis ea vitae.
            survey_monkey_id: Rem aperiam aut iusto.
            survey_reminder_rate_days: 7674533990149798869
            survey_send_date: Molestias a fuga.
            survey_title: Et dicta sed porro saepe eos unde.
        required:
            - committee_uid
    SurveyUpdateSurveyRequestBody:
        title: SurveyUpdateSurveyRequestBody
        type: object
        properties:
            committee_uid:
                type: string
                description: Committee UID to send survey to
                example: qa1e8536-a985-4cf5-b981-a170927a1d11
            committee_voting_enabled:
                type: boolean
                description: Whether committee voting is enabled
                example: true
            creator_id:
                type: string
                description: Creator's user ID
                example: Nemo architecto exercitationem autem dolores.
            email_body:
                type: string
                description: Email body HTML content
                example: Ipsum sunt.
            email_body_text:
                type: string
                description: Email body plain text content
                example: Eveniet aliquam provident quam dicta.
            email_subject:
                type: string
                description: Email subject line
                example: Facilis rerum alias nisi.
            survey_cutoff_date:
                type: string
                description: Survey cutoff/end date (RFC3339 format)
                example: Occaecati et quia quia.
            survey_reminder_rate_days:
                type: integer
                description: Days between automatic reminder emails (0 = no reminders)
                example: 510201010043617786
                format: int64
            survey_send_date:
                type: string
                description: Date to send the survey (RFC3339 format)
                example: Et aspernatur aliquid aut.
            survey_title:
                type: string
                description: Survey title
                example: Praesentium voluptas nihil atque velit molestiae.
        example:
            committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
            committee_voting_enabled: true
            creator_id: Sit unde laudantium voluptate cum.
            email_body: Quidem officia.
            email_body_text: Repellendus beatae quae impedit quis.
            email_subject: Molestiae quod consequuntur qui vero.
            survey_cutoff_date: Voluptatum quod aliquam ducimus voluptas.
            survey_reminder_rate_days: 8771076406201222434
            survey_send_date: Dolores voluptas.
            survey_title: Velit molestiae sunt.
    SurveyValidateEmailRequestBody:
        title: SurveyValidateEmailRequestBody
        type: object
        properties:
            body:
                type: string
                description: Email body template
                example: Aut officia accusantium nihil.
            subject:
                type: string
                description: Email subject template
                example: Exercitationem maxime sunt quidem et.
        example:
            body: Quidem rem ex nesciunt natus.
            subject: Tempore est eveniet illo.
    UnauthorizedError:
        title: UnauthorizedError
        type: object
        properties:
            code:
                type: string
                description: HTTP status code
                example: Et quo voluptatem qui accusantium et.
            message:
                type: string
                description: Error message
                example: Qui nesciunt qui.
        description: Unauthorized
        example:
            code: Vel neque dolorem totam ipsa iste omnis.
            message: Autem odit voluptas voluptatibus.
        required:
            - code
            - message
    UserEmail:
        title: UserEmail
        type: object
        properties:
            email_address:
                type: string
                description: Email address
                example: Est beatae omnis veniam.
            id:
                type: string
                description: Email ID
                example: Quas quia eius dolorum nemo sit.
            is_primary:
                type: boolean
                description: Whether this is the primary email
                example: false
        description: User email information
        example:
            email_address: Et maiores exercitationem voluptas numquam.
            id: Laboriosam aut tempora officiis voluptatem.
            is_primary: true
    ValidateEmailResult:
        title: ValidateEmailResult
        type: object
        properties:
            body:
                type: string
                description: Validated email body
                example: An example survey body with the quarter Q1
            subject:
                type: string
                description: Validated email subject
                example: An example survey subject with the year 2023
        example:
            body: An example survey body with the quarter Q1
            subject: An example survey subject with the year 2023
        required:
            - body
            - subject
securityDefinitions:
    jwt_header_Authorization:
        type: apiKey
        description: |-
            Heimdall JWT authorization

            **Security Scopes**:
              * `read:projects`: Read project data
              * `manage:projects`: Manage projects
              * `manage:surveys`: Manage surveys
        name: Authorization
        in: header