{"swagger": "2.0", "info": {"title": "Snippets API", "description": "Test description", "termsOfService": "https://www.google.com/policies/terms/", "contact": {"email": "contact@snippets.local"}, "license": {"name": "BSD License"}, "version": "v1"}, "host": "app.haekka.com", "schemes": ["https"], "basePath": "/", "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}}, "security": [{"Bearer": []}], "paths": {"/analytics/{employee_id}/{campaign_attack_id}/{nonce}/cleardot": {"get": {"operationId": "analytics_cleardot_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["analytics"]}, "parameters": [{"name": "campaign_attack_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "nonce", "in": "path", "required": true, "type": "string"}]}, "/api/answers/quiz/{id}": {"delete": {"operationId": "api_answers_quiz_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this quiz question answer.", "required": true, "type": "string", "format": "uuid"}]}, "/api/answers/{id}": {"delete": {"operationId": "api_answers_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this answer.", "required": true, "type": "string", "format": "uuid"}]}, "/api/answers/{id}/assessment": {"delete": {"operationId": "api_answers_assessment_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this Assessment Answer.", "required": true, "type": "string", "format": "uuid"}]}, "/api/answers/{id}/next_lesson/{employee_uid}": {"get": {"operationId": "api_answers_next_lesson_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeLesson"}}}, "tags": ["api"]}, "parameters": [{"name": "employee_uid", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "description": "A UUID string identifying this employee lesson.", "required": true, "type": "string", "format": "uuid"}]}, "/api/assessments/": {"get": {"operationId": "api_assessments_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Assessment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_assessments_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/assessments/company": {"get": {"operationId": "api_assessments_company_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrainingCompanyAssessment"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_assessments_company_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrainingCompanyAssessmentWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/TrainingCompanyAssessmentWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/assessments/company/{id}": {"get": {"operationId": "api_assessments_company_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingCompanyAssessment"}}}, "tags": ["api"]}, "put": {"operationId": "api_assessments_company_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrainingCompanyAssessment"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingCompanyAssessment"}}}, "tags": ["api"]}, "patch": {"operationId": "api_assessments_company_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrainingCompanyAssessment"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingCompanyAssessment"}}}, "tags": ["api"]}, "delete": {"operationId": "api_assessments_company_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/assessments/{id}": {"get": {"operationId": "api_assessments_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Assessment"}}}, "tags": ["api"]}, "put": {"operationId": "api_assessments_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_assessments_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AssessmentSerializerWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_assessments_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/installations": {"post": {"operationId": "api_companies_installations_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SlackInstallation"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SlackInstallation"}}}, "tags": ["api"]}, "parameters": []}, "/api/companies/installations/check/{id}": {"get": {"operationId": "api_companies_installations_check_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/installations/{team_id}": {"get": {"operationId": "api_companies_installations_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SlackInstallation"}}}, "tags": ["api"]}, "parameters": [{"name": "team_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/sync/check/{id}": {"get": {"operationId": "api_companies_sync_check_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/sync/{id}": {"post": {"operationId": "api_companies_sync_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{company_id}/subscription-url": {"get": {"operationId": "api_companies_subscription-url_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/employee/top": {"get": {"operationId": "api_companies_employee_top_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TopPerformer"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/employees/curriculums/{curriculum_id}": {"get": {"operationId": "api_companies_employees_curriculums_read", "description": "This endpoint returns a list of EmployeeTraining,\nfiltering by company and training.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingManageList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/employees/list": {"get": {"operationId": "api_companies_employees_list_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeManageList"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/employees/{employee_id}": {"delete": {"operationId": "api_companies_employees_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/employees/{employee_id}/admin": {"put": {"operationId": "api_companies_employees_admin_update", "description": "Update employee admin status. Requires admin privileges and company access.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Employee"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Employee"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_employees_admin_partial_update", "description": "Update employee admin status. Requires admin privileges and company access.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Employee"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Employee"}}}, "tags": ["api"]}, "parameters": [{"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/engagements/metrics": {"get": {"operationId": "api_companies_engagements_metrics_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/evdt/analytics/action": {"get": {"operationId": "api_companies_evdt_analytics_action_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/evdt/analytics/event": {"get": {"operationId": "api_companies_evdt_analytics_event_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/groups": {"get": {"operationId": "api_companies_groups_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_companies_groups_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/groups/{group_id}": {"get": {"operationId": "api_companies_groups_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_groups_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_groups_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "group_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/groups/{group_id}/members/list": {"get": {"operationId": "api_companies_groups_members_list_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/GroupMember"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "group_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/home": {"get": {"operationId": "api_companies_home_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyHomeData"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/integrations": {"get": {"operationId": "api_companies_integrations_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyIntegrations"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/merge/delete/{integration}": {"delete": {"operationId": "api_companies_merge_delete_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/merge/update": {"patch": {"operationId": "api_companies_merge_update_partial_update", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/notifications/get": {"get": {"operationId": "api_companies_notifications_get_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Notifications"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this notification.", "required": true, "type": "string", "format": "uuid"}]}, "/api/companies/{id}/notifications/schedule": {"get": {"operationId": "api_companies_notifications_schedule_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyNotificationSchedule"}}}}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_notifications_schedule_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyNotificationSchedule"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyNotificationSchedule"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/notifications/update/": {"patch": {"operationId": "api_companies_notifications_update_partial_update", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/attacks/{phishing_attack_id}/report": {"get": {"operationId": "api_companies_phishing_attacks_report_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "phishing_attack_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns": {"get": {"operationId": "api_companies_phishing_campaigns_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingCampaign"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_companies_phishing_campaigns_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCampaign"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaign"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/actions": {"get": {"operationId": "api_companies_phishing_campaigns_actions_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingCampaignAction"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "description": "A UUID string identifying this phishing campaign action.", "required": true, "type": "string", "format": "uuid"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/attacks": {"get": {"operationId": "api_companies_phishing_campaigns_attacks_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaignAttack"}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/delete": {"delete": {"operationId": "api_companies_phishing_campaigns_delete_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/details": {"get": {"operationId": "api_companies_phishing_campaigns_details_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaign"}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/details/table": {"get": {"operationId": "api_companies_phishing_campaigns_details_table_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/details/{employee_id}": {"get": {"operationId": "api_companies_phishing_campaigns_details_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/edit": {"put": {"operationId": "api_companies_phishing_campaigns_edit_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCampaign"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaign"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_phishing_campaigns_edit_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCampaign"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaign"}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/employees": {"get": {"operationId": "api_companies_phishing_campaigns_employees_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MinimalEmployee"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/launch": {"post": {"operationId": "api_companies_phishing_campaigns_launch_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCampaignAttack"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaignAttack"}}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/campaigns/{campaign_id}/remove/{employee_id}": {"delete": {"operationId": "api_companies_phishing_campaigns_remove_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/metrics": {"get": {"operationId": "api_companies_phishing_metrics_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/settings": {"get": {"operationId": "api_companies_phishing_settings_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingCompanySettings"}}}}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_phishing_settings_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCompanySettings"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingCompanySettings"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/phishing/whitelist/{template_id}": {"get": {"operationId": "api_companies_phishing_whitelist_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_companies_phishing_whitelist_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "template_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/report": {"get": {"operationId": "api_companies_report_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/slack-groups": {"get": {"operationId": "api_companies_slack-groups_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/stats": {"get": {"operationId": "api_companies_stats_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrainingStats"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/streams/{stream_id}": {"get": {"operationId": "api_companies_streams_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStream"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/streams/{stream_id}/posts": {"get": {"operationId": "api_companies_streams_posts_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyStreamPostWithStatistics"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/streams/{stream_id}/posts/{post_id}": {"get": {"operationId": "api_companies_streams_posts_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStreamPost"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_streams_posts_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyStreamPost"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStreamPost"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_streams_posts_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyStreamPost"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStreamPost"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_streams_posts_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "post_id", "in": "path", "required": true, "type": "string"}, {"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/streams/{stream}/subscribe": {"put": {"operationId": "api_companies_streams_subscribe_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyStream"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStream"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_streams_subscribe_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyStream"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyStream"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "stream", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/tokens/delete": {"delete": {"operationId": "api_companies_tokens_delete_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/tokens/generate": {"post": {"operationId": "api_companies_tokens_generate_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique value identifying this Company API key.", "required": true, "type": "string"}]}, "/api/companies/{id}/tokens/get": {"get": {"operationId": "api_companies_tokens_get_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyAPIKey"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings": {"get": {"operationId": "api_companies_trainings_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrainingSerializerCompany"}}}}}}, "tags": ["api"]}, "post": {"operationId": "create company training based on editable curriculum", "description": "Many trainings are created as there are curriculums for type of course.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"curriculum": {"description": "UUID of Curriculum you want to create Training from. Must be editable (is_editable=True)", "type": "string"}, "created_by": {"description": "UUID of admin employee that's creating a company Training", "type": "string"}, "start_date": {"description": "Start date of company Training", "type": "string"}, "end_date": {"description": "End date of company Training", "type": "string"}, "renew_date": {"description": "Renew date of company Training", "type": "string"}, "renew_cycle": {"description": "At what interval will company Training be renews. Can be one of the following values: 'none', 'quarterly', 'semi-annual', 'annual'.", "type": "string"}}}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Training"}}, "404": {"description": "Not found"}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/list": {"get": {"operationId": "api_companies_trainings_list_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ListTranignsSerializers"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/renewed/{curriculum_id}": {"get": {"operationId": "api_companies_trainings_renewed_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/RenewedTraining"}}}}, "tags": ["api"]}, "post": {"operationId": "api_companies_trainings_renewed_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RenewedTraining"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/RenewedTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/tags": {"get": {"operationId": "api_companies_trainings_tags_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrainingTag"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/tags/{tag_id}": {"get": {"operationId": "api_companies_trainings_tags_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingTag"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_trainings_tags_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrainingTag"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingTag"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_trainings_tags_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrainingTag"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingTag"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_trainings_tags_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "tag_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}": {"get": {"operationId": "api_companies_trainings_read", "description": "To create a training you have to be an admin", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Training"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_trainings_update", "description": "To create a training you have to be an admin", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Training"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Training"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_trainings_partial_update", "description": "To create a training you have to be an admin", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Training"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Training"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_trainings_delete", "description": "To create a training you have to be an admin", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this training.", "required": true, "type": "string", "format": "uuid"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/before": {"get": {"operationId": "api_companies_trainings_before_read", "description": "Get Training Before Edit", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingGetBeforeEdit"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this training.", "required": true, "type": "string", "format": "uuid"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/lessons": {"get": {"operationId": "api_companies_trainings_lessons_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingList"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/migrate-training": {"post": {"operationId": "api_companies_trainings_migrate-training_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/publish": {"post": {"operationId": "api_companies_trainings_publish_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Training"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Training"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this training.", "required": true, "type": "string", "format": "uuid"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/renew": {"post": {"operationId": "api_companies_trainings_renew_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Training"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Training"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this training.", "required": true, "type": "string", "format": "uuid"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/renew-approve-migration": {"post": {"operationId": "api_companies_trainings_renew-approve-migration_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MigrateCurriculumOnTrainingRenew"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MigrateCurriculumOnTrainingRenew"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/statistics": {"get": {"operationId": "api_companies_trainings_statistics_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrainingStatistics"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/trainings/{training_id}/{employee_id}/getevidence": {"get": {"operationId": "api_companies_trainings_getevidence_list", "description": "This endpoint generates an excel with the data of the\nemployees with training completed in the company.", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/users_settings": {"get": {"operationId": "api_companies_users_settings_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserAccountsSettings"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_users_settings_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserAccountsSettings"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserAccountsSettings"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_users_settings_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserAccountsSettings"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserAccountsSettings"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_users_settings_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/workflows": {"get": {"operationId": "api_companies_workflows_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WorkflowList"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_companies_workflows_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WorkflowList"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WorkflowList"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/workflows/{workflow_id}": {"get": {"operationId": "api_companies_workflows_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Workflow"}}}, "tags": ["api"]}, "put": {"operationId": "api_companies_workflows_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Workflow"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Workflow"}}}, "tags": ["api"]}, "patch": {"operationId": "api_companies_workflows_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Workflow"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Workflow"}}}, "tags": ["api"]}, "delete": {"operationId": "api_companies_workflows_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/workflows/{workflow_id}/assign": {"post": {"operationId": "api_companies_workflows_assign_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/companies/{id}/workflows/{workflow_id}/assign/all": {"post": {"operationId": "api_companies_workflows_assign_all_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/curriculums/": {"get": {"operationId": "api_curriculums_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Curriculum"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_curriculums_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Curriculum"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Curriculum"}}}, "tags": ["api"]}, "parameters": []}, "/api/curriculums/authors": {"get": {"operationId": "api_curriculums_authors_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/curriculums/tags": {"get": {"operationId": "api_curriculums_tags_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CurriculumTag"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/curriculums/types": {"get": {"operationId": "api_curriculums_types_list", "description": "Only the types of courses with created curriculums are shown.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CurriculumTypeWithoutTitles"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/curriculums/{curriculum_id}/content": {"get": {"operationId": "api_curriculums_content_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CurriculumContent"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/curriculums/{id}": {"get": {"operationId": "api_curriculums_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Curriculum"}}}, "tags": ["api"]}, "put": {"operationId": "api_curriculums_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Curriculum"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Curriculum"}}}, "tags": ["api"]}, "patch": {"operationId": "api_curriculums_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Curriculum"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Curriculum"}}}, "tags": ["api"]}, "delete": {"operationId": "api_curriculums_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this curriculum.", "required": true, "type": "string", "format": "uuid"}]}, "/api/curriculums/{id}/catalogDemo": {"get": {"operationId": "api_curriculums_catalogDemo_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "put": {"operationId": "api_curriculums_catalogDemo_update", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "patch": {"operationId": "api_curriculums_catalogDemo_partial_update", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "delete": {"operationId": "api_curriculums_catalogDemo_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/curriculums/{id}/global": {"get": {"operationId": "api_curriculums_global_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GlobalCurriculum"}}}, "tags": ["api"]}, "put": {"operationId": "api_curriculums_global_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/GlobalCurriculum"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GlobalCurriculum"}}}, "tags": ["api"]}, "patch": {"operationId": "api_curriculums_global_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/GlobalCurriculum"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/GlobalCurriculum"}}}, "tags": ["api"]}, "delete": {"operationId": "api_curriculums_global_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this curriculum.", "required": true, "type": "string", "format": "uuid"}]}, "/api/curriculums/{id}/reorder_content": {"post": {"operationId": "api_curriculums_reorder_content_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CurriculumContent"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CurriculumContent"}}}, "tags": ["api"]}, "put": {"operationId": "api_curriculums_reorder_content_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CurriculumContent"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CurriculumContent"}}}, "tags": ["api"]}, "patch": {"operationId": "api_curriculums_reorder_content_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CurriculumContent"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CurriculumContent"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/channel_engagement/{company_quiz_id}/results": {"get": {"operationId": "api_employees_channel_engagement_results_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeChannelEngagementResults"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/email_invitation": {"get": {"operationId": "api_employees_email_invitation_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmailInvitation"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_employees_email_invitation_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmailInvitation"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/EmailInvitation"}}}, "tags": ["api"]}, "parameters": []}, "/api/employees/email_invitation/{id}": {"get": {"operationId": "api_employees_email_invitation_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmailInvitation"}}}, "tags": ["api"]}, "put": {"operationId": "api_employees_email_invitation_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmailInvitation"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmailInvitation"}}}, "tags": ["api"]}, "patch": {"operationId": "api_employees_email_invitation_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmailInvitation"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmailInvitation"}}}, "tags": ["api"]}, "delete": {"operationId": "api_employees_email_invitation_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/employee_lesson/{employee_lesson_id}/lesson_attempt": {"get": {"operationId": "api_employees_employee_lesson_lesson_attempt_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeLessonAttempt"}}}, "tags": ["api"]}, "parameters": [{"name": "employee_lesson_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/employee_lesson/{employee_lesson_id}/question": {"get": {"operationId": "api_employees_employee_lesson_question_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Question"}}}, "tags": ["api"]}, "parameters": [{"name": "employee_lesson_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/login": {"post": {"operationId": "Login slack user or creates one", "description": "\nThis endpoint does slack login user matching process.\n<b>You must execute this endpoint FIRST TIME you enter on APP.</b>\nAll fields are required.\nLater, You <b>must include in all calls Header</b>:<br/>\n    <b>Slack-User-Id</b>: slack_user_id__slack_user_company <br/>\n    <i>(example)</i> AAAAAAA__BBBBBB<br/><br/>\n    OR IF YOU PREFER you can include two params<br/><br/>\n    <b>Slack-Uid</b>: AAAAAAA<br/>\n    <b>Slack-Cid</b>: BBBBBBB<br/><br/>\n    And let the middleware makes all happens.\n", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"slack_user_id": {"description": "Slack User ID", "type": "string"}, "slack_user_name": {"description": "Slack User Name", "type": "string"}, "slack_user_email": {"description": "Slack User Email", "type": "string"}, "slack_company_id": {"description": "Slack Company ID", "type": "string"}, "slack_company_title": {"description": "Slack Company name", "type": "string"}}}}], "responses": {"200": {"description": "response description", "schema": {"$ref": "#/definitions/EmployeeLogin"}}, "400": {"description": "Bad Request"}}, "tags": ["api"]}, "parameters": []}, "/api/employees/login/google": {"post": {"operationId": "Login google user", "description": "Endpoint that accepts id_token of google user, verifies it,\nfetches data about that google user, and tries to find matching Employee", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"token": {"description": "Google User id_token", "type": "string"}}}}], "responses": {"200": {"description": "success", "schema": {"$ref": "#/definitions/Employee"}}, "400": {"description": "ID Token is required"}}, "tags": ["api"]}, "parameters": []}, "/api/employees/quizzes/{company_quiz_id}/anonymous_results": {"get": {"operationId": "api_employees_quizzes_anonymous_results_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeEngagementsAnonymousResponses"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{company_quiz_id}/channel": {"post": {"operationId": "open a bulk employees weekly for one or more Slack channels", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"employee_data": {"type": "object", "properties": {"channels": {"type": "array", "items": {"type": "object", "properties": {"slack_channel": {"description": "ID of Slack channel from which                                            we'll add users to a quiz", "type": "string"}, "automatically_enroll": {"description": "Should we automatically enroll a new user \\ # noqa\n                                            into a quiz when he joins this slack channel", "type": "boolean"}}}}}}, "manually_selected_employees": {"description": "IDs of employees manually selected (users that already exists in our database)", "type": "array", "items": {"type": "string"}}}}}], "responses": {"200": {"description": "Emplyoee weekly bulk open for one or more Slack channels", "schema": {"$ref": "#/definitions/EmployeeWeeklyBulkOpen"}}, "400": {"description": "Bad Request"}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{company_quiz_id}/company": {"post": {"operationId": "Assign a Quiz to every Employee in a Company", "description": "Creates EmployeeWeekly for every Employee in a Company. Receive status 200 OK if successful. Receive 404 if no active company weekly quiz is found.Receive 500 in case a Company used up all licences or Slack API returns an Error.", "parameters": [], "responses": {"200": {"description": "Created", "schema": {"$ref": "#/definitions/EmployeeWeekly"}}, "404": {"description": "Not Found"}, "500": {"description": "Internal Error"}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{company_quiz_id}/okta": {"post": {"operationId": "api_employees_quizzes_okta_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{company_quiz_id}/results": {"get": {"operationId": "api_employees_quizzes_results_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeEngagementsResults"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{company_quiz_id}/selection": {"post": {"operationId": "api_employees_quizzes_selection_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/quizzes/{engagement_id}/send_reminder": {"post": {"operationId": "api_employees_quizzes_send_reminder_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeWeekly"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/EmployeeWeekly"}}}, "tags": ["api"]}, "parameters": [{"name": "engagement_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/streams/{stream_id}": {"get": {"operationId": "api_employees_streams_read", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/streams/{stream_id}/channel": {"post": {"operationId": "api_employees_streams_channel_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/streams/{stream_id}/company": {"post": {"operationId": "api_employees_streams_company_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/streams/{stream_id}/selection": {"post": {"operationId": "api_employees_streams_selection_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/channel": {"post": {"operationId": "bulk create employee trainings for the selected Slack channels, and the manually selected employees", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"company_id": {"description": "ID of the company we want to bulk assign employees to training for", "type": "string"}, "employee_data": {"type": "object", "properties": {"channels": {"type": "array", "items": {"type": "object", "properties": {"slack_channel": {"description": "ID of Slack channel from which                                            we'll add users to a training", "type": "string"}, "automatically_enroll": {"description": "Should we automatically enroll a new user \\ # noqa\n                                            into a training when he joins this slack channel", "type": "boolean"}}}}}}, "manually_selected_users": {"description": "IDs of the manually selected employees (can be outside of the Slack workspace)", "type": "array", "items": {"description": "Haekka employees' IDs", "type": "string"}}}}}], "responses": {"200": {"description": "Emplyoee training bulk open for one or more Slack channels", "schema": {"$ref": "#/definitions/EmployeeTrainingBulkOpen"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/company": {"post": {"operationId": "bulk create employee trainings for the entire company's Slack workspace, and the manually selected employees", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"company_id": {"description": "ID of the company we want to bulk assign employees to training for", "type": "string"}, "manually_selected_users": {"description": "IDs of the manually selected employees (can be outside of the Slack workspace)", "type": "array", "items": {"description": "Haekka employees' IDs", "type": "string"}}}}}], "responses": {"200": {"description": "Emplyoee training bulk open for comapany", "schema": {"$ref": "#/definitions/EmployeeTrainingBulkOpen"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/docebo": {"post": {"operationId": "api_employees_trainings_docebo_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/google": {"post": {"operationId": "Employee training bulk open for Google Workspace", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"company_id": {"description": "ID of comapny we want to open bulk training for", "type": "string"}, "auto_enroll_google": {"description": "True if we want to enroll new employees from Google Workspace into this training", "type": "boolean"}}}}], "responses": {"200": {"description": "Employee training bulk open for Google Workspace", "schema": {"$ref": "#/definitions/EmployeeTrainingBulkOpen"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/groups": {"post": {"operationId": "api_employees_trainings_groups_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/okta": {"post": {"operationId": "api_employees_trainings_okta_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/seismic": {"post": {"operationId": "api_employees_trainings_seismic_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/selection": {"post": {"operationId": "api_employees_trainings_selection_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/send_bulk_reminder": {"post": {"operationId": "Send bulk training reminder to employees", "description": "Send bulk training reminder to employees. Receive status 200 OK if successful or 404 if no curriculum or training is found.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"company_id": {"description": "ID of Company", "type": "string"}, "employees": {"description": "Slack User Name", "type": "array", "items": {"description": "Slack ID's of users we want to send a reminder to", "type": "string"}}}}}], "responses": {"200": {"description": ""}, "400": {"description": "Bad Request"}, "500": {"description": "Internal Error"}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{curriculum_id}/send_reminder": {"post": {"operationId": "api_employees_trainings_send_reminder_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeTraining"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/EmployeeTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{training_id}/alert_employees_of_training": {"post": {"operationId": "api_employees_trainings_alert_employees_of_training_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{training_id}/bulk_update": {"post": {"operationId": "api_employees_trainings_bulk_update_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/trainings/{training_id}/certificate": {"get": {"operationId": "api_employees_trainings_certificate_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_employees_trainings_certificate_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/validate_csv": {"post": {"operationId": "api_employees_validate_csv_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/employees/workflow/assigned_all": {"get": {"operationId": "api_employees_workflow_assigned_all_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/employees/workflow/{employee_workflow_id}/supress": {"post": {"operationId": "api_employees_workflow_supress_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "employee_workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/workflow/{workflow_id}": {"get": {"operationId": "api_employees_workflow_read", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/workflow/{workflow_id}/channel": {"post": {"operationId": "api_employees_workflow_channel_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/workflow/{workflow_id}/company": {"post": {"operationId": "api_employees_workflow_company_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/workflow/{workflow_id}/selection": {"post": {"operationId": "api_employees_workflow_selection_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/post/{post_id}": {"put": {"operationId": "api_employees_post_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeStreamPost"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeStreamPost"}}}, "tags": ["api"]}, "patch": {"operationId": "api_employees_post_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeStreamPost"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeStreamPost"}}}, "tags": ["api"]}, "parameters": [{"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "post_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}": {"get": {"operationId": "api_employees_training-assessment_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeAssessmentQuestion"}}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/attempts": {"get": {"operationId": "api_employees_training-assessment_attempts_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingAssessmentAttempt"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/complete-training": {"post": {"operationId": "api_employees_training-assessment_complete-training_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/question/{question_id}": {"post": {"operationId": "api_employees_training-assessment_question_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "question_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/question/{question_id}/attempts": {"get": {"operationId": "api_employees_training-assessment_question_attempts_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingAssessmentQuestionAttempt"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "question_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/retake": {"post": {"operationId": "api_employees_training-assessment_retake_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{employee_id}/training-assessment/{assessment_id}/summary": {"get": {"operationId": "api_employees_training-assessment_summary_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeAssessmentSummary"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}": {"put": {"operationId": "api_employees_update", "description": "When the employee is updated, it is checked if the request\ncontains the field is_admin to false, it is checked that\nat least one employee with the field is_admin to true exists\nand if it does not, the field is_admin is not updated.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Employee"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Employee"}}}, "tags": ["api"]}, "patch": {"operationId": "api_employees_partial_update", "description": "When the employee is updated, it is checked if the request\ncontains the field is_admin to false, it is checked that\nat least one employee with the field is_admin to true exists\nand if it does not, the field is_admin is not updated.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Employee"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Employee"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this employee.", "required": true, "type": "string", "format": "uuid"}]}, "/api/employees/{id}/details": {"get": {"operationId": "api_employees_details_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Employee"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/publish_event": {"post": {"operationId": "api_employees_publish_event_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PublishPointsEvent"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PublishPointsEvent"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this employee.", "required": true, "type": "string", "format": "uuid"}]}, "/api/employees/{id}/quizzes": {"get": {"operationId": "api_employees_quizzes_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeWeekly"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/quizzes/{employee_weekly_id}/unassign": {"post": {"operationId": "Unassign Quiz from Employee", "description": "Deactivate EmployeeWeekly. Receive status 200 OK if successful or 404 if no active employee weekly is found.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object"}}], "responses": {"200": {"description": "Created", "schema": {"$ref": "#/definitions/EmployeeWeekly"}}, "404": {"description": "Not Found"}, "500": {"description": "Internal Error"}}, "tags": ["api"]}, "parameters": [{"name": "employee_weekly_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/quizzes/{quiz_id}": {"get": {"operationId": "api_employees_quizzes_read", "description": "In this endpoint we return the question and\nanswers of a quiz within a training.\nCreated an EmployeeWeekly from a Weekly.", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "open new employee weekly", "description": "In this endpoint we return the question and\nanswers of a quiz within a training.\nCreated an EmployeeWeekly from a Weekly.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {"answers": {"description": "send selected answer", "type": "string"}}}}], "responses": {"200": {"description": "weekly Quiz description", "schema": {"$ref": "#/definitions/EmployeeWeeklyQuizQuestionAndAnswer"}}, "400": {"description": "Bad Request"}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/quizzes/{schedule_id}/acknowledge": {"post": {"operationId": "api_employees_quizzes_acknowledge_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "schedule_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/simple-trainings": {"get": {"operationId": "api_employees_simple-trainings_list", "description": "Retrieve Employee Trainings list by Employee\nId with the percentage of completed lessons .", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingsWithoutLessons"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/streams/{stream_id}/unassign": {"post": {"operationId": "api_employees_streams_unassign_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "stream_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings": {"get": {"operationId": "api_employees_trainings_list", "description": "Retrieve Employee Trainings list by Employee\nId with the percentage of completed lessons .", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeHomeTraining"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{curriculum_id}/close": {"put": {"operationId": "api_employees_trainings_close_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeTraining"}}}, "tags": ["api"]}, "patch": {"operationId": "api_employees_trainings_close_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "curriculum_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}": {"get": {"operationId": "api_employees_trainings_read", "description": "Retrieve a single Employee Training", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/attempts": {"get": {"operationId": "api_employees_trainings_attempts_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingAttempt"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/checkgrade": {"post": {"operationId": "api_employees_trainings_checkgrade_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/items": {"get": {"operationId": "api_employees_trainings_items_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingItems"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/lessons": {"get": {"operationId": "api_employees_trainings_lessons_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EmployeeListLesson"}}}}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}": {"get": {"operationId": "api_employees_trainings_lessons_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeLesson"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "lesson_id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}/question/{question_id}/branching": {"post": {"operationId": "api_employees_trainings_lessons_question_branching_create", "description": "In this endpoint we change the completion\nstatus of the EmployeeLesson instance.\nIt is checked if the EmployeeLesson\n instances associated to a Training are complete,\nif it is the case, the EmployeeTraining\nfinish_date is updated with the current date.", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "lesson_id", "in": "path", "required": true, "type": "string"}, {"name": "question_id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}/question_submit": {"post": {"operationId": "api_employees_trainings_lessons_question_submit_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "lesson_id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/trainings/{training_id}/renew": {"put": {"operationId": "api_employees_trainings_renew_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeTraining"}}}, "tags": ["api"]}, "patch": {"operationId": "api_employees_trainings_renew_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/EmployeeTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "training_id", "in": "path", "required": true, "type": "string"}]}, "/api/employees/{id}/workflow/{workflow_id}/unassign": {"post": {"operationId": "api_employees_workflow_unassign_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "workflow_id", "in": "path", "required": true, "type": "string"}]}, "/api/evdtevents/": {"get": {"operationId": "api_evdtevents_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/EVDTEvent"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/get_employees_in_stream": {"post": {"operationId": "api_get_employees_in_stream_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/get_trainings": {"post": {"operationId": "api_get_trainings_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/": {"get": {"operationId": "api_integrations_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ExternalAppPolymorphic"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/docebo/courses": {"get": {"operationId": "api_integrations_docebo_courses_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/DoceboCourseList"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/google/groups": {"get": {"operationId": "api_integrations_google_groups_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/GoogleGroupsList"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/merge/{integration}/company/{company_id}/employee/{employee_id}/get_link_token": {"get": {"operationId": "api_integrations_merge_company_employee_get_link_token_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/merge/{integration}/company/{company_id}/get_merge_groups": {"get": {"operationId": "api_integrations_merge_company_get_merge_groups_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/merge/{integration}/company/{company_id}/remove_merge_integration": {"post": {"operationId": "api_integrations_merge_company_remove_merge_integration_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/merge/{integration}/company/{company_id}/store_access_token": {"post": {"operationId": "api_integrations_merge_company_store_access_token_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/oauth/callback": {"get": {"operationId": "api_integrations_oauth_callback_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/seismic/content": {"get": {"operationId": "api_integrations_seismic_content_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SeismicContentList"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/integrations/webhook/{integration}": {"get": {"operationId": "api_integrations_webhook_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_integrations_webhook_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/{id}/company/{company_id}": {"get": {"operationId": "api_integrations_company_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExternalAppPolymorphic"}}}, "tags": ["api"]}, "put": {"operationId": "api_integrations_company_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExternalAppPolymorphic"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExternalAppPolymorphic"}}}, "tags": ["api"]}, "patch": {"operationId": "api_integrations_company_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExternalAppPolymorphic"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExternalAppPolymorphic"}}}, "tags": ["api"]}, "delete": {"operationId": "api_integrations_company_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "id", "in": "path", "description": "A UUID string identifying this external app installation.", "required": true, "type": "string", "format": "uuid"}]}, "/api/integrations/{installation}/company/{company_id}/basic_http_auth": {"post": {"operationId": "api_integrations_company_basic_http_auth_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "installation", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/{installation}/company/{company_id}/oauth/url": {"get": {"operationId": "api_integrations_company_oauth_url_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_integrations_company_oauth_url_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "installation", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/{installation}/company/{company_id}/wh_config": {"post": {"operationId": "api_integrations_company_wh_config_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExternalAppWebhookConfigResponse"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ExternalAppWebhookConfigResponse"}}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "installation", "in": "path", "required": true, "type": "string"}]}, "/api/integrations/{integration}/company/{company_id}/get_webhook_auth_header": {"get": {"operationId": "api_integrations_company_get_webhook_auth_header_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}, {"name": "integration", "in": "path", "required": true, "type": "string"}]}, "/api/internal-event-logger": {"post": {"operationId": "api_internal-event-logger_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/lessons/": {"get": {"operationId": "api_lessons_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Lesson"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_lessons_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LessonWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/LessonWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/lessons/lesson_image_upload/": {"post": {"operationId": "api_lessons_lesson_image_upload_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "consumes": ["multipart/form-data", "application/x-www-form-urlencoded"], "tags": ["api"]}, "parameters": []}, "/api/lessons/update_lesson_image/": {"post": {"operationId": "api_lessons_update_lesson_image_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/lessons/wistia/refresh_token": {"get": {"operationId": "api_lessons_wistia_refresh_token_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/lessons/wistia/update_video_upload": {"get": {"operationId": "api_lessons_wistia_update_video_upload_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_lessons_wistia_update_video_upload_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "delete": {"operationId": "api_lessons_wistia_update_video_upload_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/lessons/{id}": {"get": {"operationId": "api_lessons_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Lesson"}}}, "tags": ["api"]}, "put": {"operationId": "api_lessons_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LessonWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/LessonWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_lessons_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LessonWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/LessonWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_lessons_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this lesson.", "required": true, "type": "string", "format": "uuid"}]}, "/api/lessons/{id}/report": {"get": {"operationId": "api_lessons_report_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_lessons_report_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/notifications/snooze_reminder": {"post": {"operationId": "api_notifications_snooze_reminder_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/cancel/": {"post": {"operationId": "api_payment_cancel_create", "description": "Cancel customer subscription", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/change-card/": {"post": {"operationId": "api_payment_change-card_create", "description": "Add or update customer card details", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/change-plan/": {"post": {"operationId": "api_payment_change-plan_create", "description": "Change customer subscription", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/charges/": {"get": {"operationId": "api_payment_charges_list", "description": "List customer charges", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Charge"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/payment/create-session/": {"post": {"operationId": "api_payment_create-session_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/current-user/": {"get": {"operationId": "api_payment_current-user_read", "description": "See the current customer/user payment details", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CurrentCustomer"}}}, "tags": ["api"]}, "parameters": []}, "/api/payment/events/": {"get": {"operationId": "api_payment_events_list", "description": "List customer events", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Event"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/payment/invoices/": {"get": {"operationId": "api_payment_invoices_list", "description": "List customer invoices", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Invoice"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/payment/plans/": {"get": {"operationId": "api_payment_plans_list", "description": "List all current plans", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/reactivate-subscription/": {"post": {"operationId": "api_payment_reactivate-subscription_create", "description": "Reactivate customer actual subscrition", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/subscription/": {"get": {"operationId": "api_payment_subscription_list", "description": "See, change/set the current customer/user subscription plan", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "post": {"operationId": "api_payment_subscription_create", "description": "See, change/set the current customer/user subscription plan", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/v2/create-session/": {"post": {"operationId": "api_payment_v2_create-session_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/payment/webhook/": {"post": {"operationId": "api_payment_webhook_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/phishing/categories": {"get": {"operationId": "api_phishing_categories_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingTemplateCategory"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/phishing/imap": {"get": {"operationId": "api_phishing_imap_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingForwardedNotificationEmailToIMAPCredentialsMapping"}}}}}}, "tags": ["api"]}, "put": {"operationId": "api_phishing_imap_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingForwardedNotificationEmailToIMAPCredentialsMapping"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PhishingForwardedNotificationEmailToIMAPCredentialsMapping"}}}, "tags": ["api"]}, "parameters": []}, "/api/phishing/imap/test/binding": {"get": {"operationId": "api_phishing_imap_test_binding_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/phishing/imap/test/configuration": {"post": {"operationId": "api_phishing_imap_test_configuration_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/phishing/templates": {"get": {"operationId": "api_phishing_templates_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PhishingTemplate"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/public/employee_trainings/": {"get": {"operationId": "Employee Training List", "description": "\nList all employee training objects. Employee Training object represents\nassignement of a training to an employee.\n\nIf you want to fetch only assigned trainings to one particular employee,\nyou can use the `employee_id` query parameter.\n\nOr if you want to see all employees assigned to a particulat training,\nyou can use the `training_id` query parameter.\n", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "employee_id", "in": "query", "description": "Employee ID", "type": "string"}, {"name": "training_id", "in": "query", "description": "Training ID", "type": "string"}, {"name": "employee_name", "in": "query", "description": "Employee Name", "type": "string"}, {"name": "training_name", "in": "query", "description": "Training Name", "type": "string"}, {"name": "completion_status", "in": "query", "description": "Employee Training Completion Status", "type": "boolean"}, {"name": "year", "in": "query", "description": "Employee Training Year", "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PublicEmployeeTraining"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/public/employee_trainings/{id}": {"get": {"operationId": "Employee Training Retrieve", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PublicEmployeeTraining"}}}, "tags": ["api"]}, "put": {"operationId": "api_public_employee_trainings_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PublicEmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PublicEmployeeTraining"}}}, "tags": ["api"]}, "patch": {"operationId": "Employee Training Update", "description": "\nUpdate an employee training object. Currently we only support completion status and completion rate update.\n", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PublicEmployeeTraining"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PublicEmployeeTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/public/employees/": {"get": {"operationId": "Employee List", "description": "\nReturns data about employees withing your company that could be\nuseful for finding out more information about their training status.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PublicEmployeeList"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/public/employees/{id}/": {"get": {"operationId": "Employee Retrieve", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PublicEmployee"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/public/phishing/extension/{employee_id}": {"post": {"operationId": "api_public_phishing_extension_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "delete": {"operationId": "api_public_phishing_extension_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/public/phishing/record/{employee_id}/{campaign_id}/{campaign_attack_id}/{action_type}": {"post": {"operationId": "api_public_phishing_record_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PhishingCampaignAction"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PhishingCampaignAction"}}}, "tags": ["api"]}, "parameters": [{"name": "action_type", "in": "path", "required": true, "type": "string"}, {"name": "campaign_attack_id", "in": "path", "required": true, "type": "string"}, {"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/public/phishing/redirect/{employee_id}/{campaign_id}/{campaign_attack_id}": {"get": {"operationId": "api_public_phishing_redirect_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "campaign_attack_id", "in": "path", "required": true, "type": "string"}, {"name": "campaign_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/public/status": {"get": {"operationId": "api_public_status_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/public/trainings/": {"get": {"operationId": "Training List", "description": "Returns all trainings going on at the moment in the your company.", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PublicTraining"}}}}}}, "tags": ["api"]}, "parameters": []}, "/api/public/trainings/assign/": {"post": {"operationId": "Training Assign", "description": "Assigns a training to employees", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PublicTrainingAssign"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PublicTrainingAssign"}}}, "tags": ["api"]}, "parameters": []}, "/api/public/trainings/{id}/": {"get": {"operationId": "Training Retrieve", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PublicTraining"}}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/public/trainings/{id}/evidence": {"get": {"operationId": "Download Training Evidence", "description": "\nDownload Training Evidence. After receiving the request, the view estimates (based on benchmarking) if the report can be returned right away. If so, the report gets generated and served in the response. Otherwise, a JsonResponse is returned with the file generation status and a corresponding message. The message contains information about when the file will be ready for download.\n\nThe API key is required and can be set in the Authorization header as a Bearer token, or can be passed as an `auth_token` query parameter (in this case pass the key only, without the `Bearer ` keyword).\n\nTo get the report to email or Slack, pass the `email` query parameter along with the `destination` parameter. Supported values for the `destination` parameter are `slack` and `email`\n", "parameters": [{"name": "auth_token", "in": "query", "description": "API key", "required": false, "type": "string"}, {"name": "email", "in": "query", "description": "email address", "required": false, "type": "string"}, {"name": "destination", "in": "query", "description": "Destination where to send the report to", "required": false, "type": "string", "enum": ["email", "slack"]}], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/questions/quiz": {"get": {"operationId": "api_questions_quiz_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/question_quiz_question_serializer"}}}, "tags": ["api"]}, "put": {"operationId": "api_questions_quiz_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/QuizQuestionWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/QuizQuestionWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_questions_quiz_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/QuizQuestionWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/QuizQuestionWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_questions_quiz_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/questions/quiz/{id}": {"delete": {"operationId": "api_questions_quiz_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this Quiz Question.", "required": true, "type": "string", "format": "uuid"}]}, "/api/questions/{id}/assessment": {"delete": {"operationId": "api_questions_assessment_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this multi choice assessment question.", "required": true, "type": "string", "format": "uuid"}]}, "/api/quizzes/": {"get": {"operationId": "api_quizzes_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/WeeklyQuiz"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_quizzes_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/quizzes/company": {"get": {"operationId": "api_quizzes_company_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CompanyWeeklyQuiz"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_quizzes_company_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/quizzes/company/{id}": {"get": {"operationId": "api_quizzes_company_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyWeeklyQuiz"}}}, "tags": ["api"]}, "put": {"operationId": "api_quizzes_company_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_quizzes_company_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CompanyWeeklyQuizWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_quizzes_company_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this company quiz.", "required": true, "type": "string", "format": "uuid"}]}, "/api/quizzes/company/{id}/schedule/{schedule_id}/evidencereport": {"get": {"operationId": "api_quizzes_company_schedule_evidencereport_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "schedule_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/company/{id}/schedule/{schedule_id}/overviewreport": {"get": {"operationId": "api_quizzes_company_schedule_overviewreport_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "schedule_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/company/{id}/schedule/{schedule_id}/send_engagement_now": {"post": {"operationId": "api_quizzes_company_schedule_send_engagement_now_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}, {"name": "schedule_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{company_engagement_id}/check_dynamic_distribution": {"get": {"operationId": "api_quizzes_check_dynamic_distribution_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_engagement_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{company_engagement_id}/check_engagement_data": {"get": {"operationId": "api_quizzes_check_engagement_data_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_engagement_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{company_engagement_id}/employee/{employee_id}/post_welcome_message": {"post": {"operationId": "api_quizzes_employee_post_welcome_message_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_engagement_id", "in": "path", "required": true, "type": "string"}, {"name": "employee_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{company_engagement_id}/schedules": {"get": {"operationId": "api_quizzes_schedules_list", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/EngagementSchedules"}}}}, "tags": ["api"]}, "parameters": [{"name": "company_engagement_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{company_quiz_id}/question_statistics": {"get": {"operationId": "api_quizzes_question_statistics_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_quiz_id", "in": "path", "required": true, "type": "string"}]}, "/api/quizzes/{id}": {"get": {"operationId": "api_quizzes_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WeeklyQuiz"}}}, "tags": ["api"]}, "put": {"operationId": "api_quizzes_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_quizzes_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/WeeklyQuizWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_quizzes_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/roles/": {"get": {"operationId": "api_roles_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Role"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_roles_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Role"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Role"}}}, "tags": ["api"]}, "parameters": []}, "/api/roles/global/{id}": {"get": {"operationId": "api_roles_global_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Role"}}}, "tags": ["api"]}, "put": {"operationId": "api_roles_global_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Role"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Role"}}}, "tags": ["api"]}, "patch": {"operationId": "api_roles_global_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Role"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Role"}}}, "tags": ["api"]}, "delete": {"operationId": "api_roles_global_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/slack/api": {"post": {"operationId": "api_slack_api_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/streams/": {"get": {"operationId": "api_streams_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Stream"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_streams_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Stream"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Stream"}}}, "tags": ["api"]}, "parameters": []}, "/api/streams/categories": {"get": {"operationId": "api_streams_categories_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/StreamPostCategory"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_streams_categories_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/StreamPostCategory"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/StreamPostCategory"}}}, "tags": ["api"]}, "parameters": []}, "/api/streams/posts": {"get": {"operationId": "api_streams_posts_list", "description": "", "parameters": [{"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/StreamPost"}}}}}}, "tags": ["api"]}, "post": {"operationId": "api_streams_posts_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/StreamPostWrite"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/StreamPostWrite"}}}, "tags": ["api"]}, "parameters": []}, "/api/streams/posts/{id}": {"get": {"operationId": "api_streams_posts_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/StreamPost"}}}, "tags": ["api"]}, "put": {"operationId": "api_streams_posts_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/StreamPostWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/StreamPostWrite"}}}, "tags": ["api"]}, "patch": {"operationId": "api_streams_posts_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/StreamPostWrite"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/StreamPostWrite"}}}, "tags": ["api"]}, "delete": {"operationId": "api_streams_posts_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this Stream Post.", "required": true, "type": "string", "format": "uuid"}]}, "/api/streams/posts/{id}/update": {"post": {"operationId": "api_streams_posts_update_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/api/streams/{id}": {"get": {"operationId": "api_streams_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Stream"}}}, "tags": ["api"]}, "put": {"operationId": "api_streams_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Stream"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Stream"}}}, "tags": ["api"]}, "patch": {"operationId": "api_streams_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Stream"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Stream"}}}, "tags": ["api"]}, "delete": {"operationId": "api_streams_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this Stream.", "required": true, "type": "string", "format": "uuid"}]}, "/api/temporary_data/{data_id}": {"get": {"operationId": "api_temporary_data_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "data_id", "in": "path", "required": true, "type": "string"}]}, "/api/vanta/oauth/callback": {"get": {"operationId": "api_vanta_oauth_callback_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": []}, "/api/vanta/oauth/url/{company_id}": {"get": {"operationId": "api_vanta_oauth_url_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}]}, "/api/vanta/sync/{company_id}": {"post": {"operationId": "api_vanta_sync_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}]}, "/api/vanta/uninstall/{company_id}": {"post": {"operationId": "api_vanta_uninstall_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["api"]}, "parameters": [{"name": "company_id", "in": "path", "required": true, "type": "string"}]}, "/authenticate_with_slack": {"get": {"operationId": "authenticate_with_slack_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["authenticate_with_slack"]}, "parameters": []}, "/feature_flags": {"get": {"operationId": "feature_flags_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["feature_flags"]}, "parameters": []}, "/file/{filename}/": {"get": {"operationId": "file_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["file"]}, "parameters": [{"name": "filename", "in": "path", "required": true, "type": "string"}]}, "/google_login/": {"get": {"operationId": "google_login_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["google_login"]}, "parameters": []}, "/html_to_pdf": {"get": {"operationId": "html_to_pdf_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["html_to_pdf"]}, "parameters": []}, "/signin_with_slack": {"get": {"operationId": "signin_with_slack_list", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["signin_with_slack"]}, "parameters": []}, "/slack/events": {"post": {"operationId": "slack_events_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["slack"]}, "parameters": []}, "/wistia_web_hook": {"post": {"operationId": "wistia_web_hook_create", "description": "", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["wistia_web_hook"]}, "parameters": []}}, "definitions": {"CurriculumType": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Curriculum type name", "type": "string", "maxLength": 60, "minLength": 1}, "titles": {"title": "Titles", "type": "string", "readOnly": true}}}, "Curriculum": {"required": ["title", "subtitle", "curriculum_type"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Training Title", "type": "string", "maxLength": 150, "minLength": 1}, "subtitle": {"title": "Training Subtitle", "type": "string", "maxLength": 255, "minLength": 1}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "curriculum_type": {"title": "Category", "type": "string", "format": "uuid"}, "training_sample": {"title": "Training Sample URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "is_technical": {"title": "Is technical", "type": "boolean"}, "is_archived": {"title": "Is archived", "type": "boolean"}, "is_published": {"title": "Is published", "type": "boolean"}, "is_editable": {"title": "Is editable", "type": "boolean", "readOnly": true}, "author_name": {"title": "Author name", "type": "string", "readOnly": true}, "author_icon_url": {"title": "Author Icon URL", "type": "string", "maxLength": 255, "x-nullable": true}, "is_already_in_use": {"title": "Is already in use", "type": "string", "readOnly": true}, "active_training_id": {"title": "Active training id", "type": "string", "readOnly": true}, "is_available_for_free": {"title": "Is available for free", "type": "boolean"}, "curriculum_type_details": {"$ref": "#/definitions/CurriculumType"}, "action_id": {"title": "Answer Action Id", "type": "string", "enum": ["lesson_submit", "branching"]}, "includes_video": {"title": "Includes video", "type": "string", "readOnly": true}, "average_length": {"title": "Average length", "type": "string", "readOnly": true}}}, "QuestionAnswer": {"required": ["answer", "lesson_question"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "answer": {"title": "Answer", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "maxLength": 150, "minLength": 1}, "correct": {"title": "Correct", "type": "boolean"}, "position": {"title": "Order", "type": "integer", "maximum": 32767, "minimum": -32768}, "lesson_question": {"title": "Lesson question", "type": "string", "format": "uuid"}, "next_lesson": {"title": "Next lesson", "type": "string", "format": "uuid", "x-nullable": true}, "explanation": {"title": "Answer Explanation", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}}}, "Question": {"required": ["explanation", "lesson", "answers", "curriculum_id", "curriculum_title", "curriculum_action_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Title", "type": "string", "readOnly": true}, "explanation": {"title": "Lesson Scenario Explanation", "type": "string", "format": "uri", "maxLength": 200, "minLength": 1}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "lesson": {"title": "Lesson", "type": "string", "format": "uuid"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuestionAnswer"}}, "type": {"title": "Lesson Type", "type": "string", "enum": ["multi_select", "multi_choice"]}, "curriculum_id": {"title": "Curriculum id", "type": "string", "minLength": 1}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "curriculum_action_id": {"title": "Curriculum action id", "type": "string", "minLength": 1}, "lesson_id": {"title": "Lesson id", "type": "string", "readOnly": true}}}, "CustomLessonVideo": {"required": ["name", "progress", "thumbnail"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "lesson": {"title": "Lesson", "type": "string", "format": "uuid", "x-nullable": true}, "service_id": {"title": "Service ID", "type": "integer", "readOnly": true}, "name": {"title": "Video Title", "type": "string", "maxLength": 300, "minLength": 1}, "duration": {"title": "Duration", "type": "integer", "readOnly": true}, "hashed_id": {"title": "Hashed id", "type": "string", "readOnly": true}, "progress": {"title": "Progress", "type": "string", "format": "decimal"}, "thumbnail": {"title": "Thumbnail", "type": "string", "maxLength": 500, "minLength": 1}, "processed": {"title": "Processed", "type": "boolean"}, "plays": {"title": "Plays", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "Lesson": {"required": ["curriculum"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Lesson Title", "type": "string", "readOnly": true, "minLength": 1}, "subtitle": {"title": "Lesson Subtitle", "type": "string", "maxLength": 200}, "curriculum": {"$ref": "#/definitions/Curriculum"}, "note": {"title": "Note", "type": "string", "readOnly": true}, "summary": {"title": "Summary", "type": "string", "readOnly": true}, "help_content": {"title": "Help Content (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "written_content": {"title": "External Resources (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "explanation_content": {"title": "Explanation Content (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "questions": {"type": "array", "items": {"$ref": "#/definitions/Question"}}, "video_url": {"title": "Video URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "video_position": {"title": "Video position", "type": "string", "enum": ["bottom", "top"]}, "includes_video": {"title": "Includes video", "type": "boolean"}, "employees_assigned": {"title": "Employees assigned", "type": "string", "readOnly": true}, "employees_finished": {"title": "Employees finished", "type": "string", "readOnly": true}, "is_simple_form": {"title": "Is Simple Lesson", "type": "boolean"}, "lesson_custom_video": {"type": "array", "items": {"$ref": "#/definitions/CustomLessonVideo"}}}}, "EmployeeLesson": {"required": ["employee_training"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee_training": {"title": "Employee lesson", "type": "string", "format": "uuid"}, "lesson": {"$ref": "#/definitions/Lesson"}, "finished": {"title": "Finished", "type": "boolean"}, "checked_answers": {"title": "Checked answers", "type": "string", "readOnly": true}, "average_length": {"title": "Average length", "type": "string", "readOnly": true}, "score": {"title": "Score", "type": "string", "readOnly": true}}}, "AssessmentAnswer": {"required": ["answer"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "x-nullable": true}, "answer": {"title": "Answer", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "maxLength": 150, "minLength": 1}, "correct": {"title": "Correct", "type": "boolean", "x-nullable": true}, "position": {"title": "Order", "type": "integer", "maximum": 32767, "minimum": -32768}, "explanation": {"title": "Answer Explanation", "type": "string", "x-nullable": true}}}, "lesson_image_in_question_serializers": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "image_name": {"title": "Image Name", "type": "string", "maxLength": 200, "x-nullable": true}, "image_url": {"title": "Image url", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "image_url_public": {"title": "Image url public", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "editor_content": {"title": "Editor Content", "type": "string", "format": "uuid", "x-nullable": true}, "content_type": {"title": "Content Type", "type": "string", "enum": ["lesson", "quiz", "engagement_question", "engagement_message", "assessment_question_content"], "x-nullable": true}}}, "editor_state_in_question_serializers": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "note_editor_state": {"title": "Stringified note Editor's content", "type": "string", "x-nullable": true}, "summary_editor_state": {"title": "Stringified summary Editor's content", "type": "string", "x-nullable": true}, "question_editor_state": {"title": "Stringified question Editor's content", "type": "string", "x-nullable": true}, "quiz_editor_state": {"title": "Stringified quiz Editor's content", "type": "string", "x-nullable": true}, "quiz_message_state": {"title": "Stringified quiz message Editor's content", "type": "string", "x-nullable": true}, "content": {"type": "array", "items": {"$ref": "#/definitions/lesson_image_in_question_serializers"}}}}, "AssessmentQuestion": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "x-nullable": true}, "position": {"title": "Position", "type": "integer", "maximum": 32767, "minimum": -32768}, "answers": {"type": "array", "items": {"$ref": "#/definitions/AssessmentAnswer"}}, "editor_content": {"$ref": "#/definitions/editor_state_in_question_serializers"}, "image_ids": {"type": "array", "items": {"type": "string", "x-nullable": true}}, "slack_markup": {"title": "Slack markup", "type": "string", "readOnly": true}, "single_select": {"title": "Single select", "type": "boolean"}, "single_correct": {"title": "Single correct", "type": "boolean"}}}, "Assessment": {"required": ["questions", "title"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "questions": {"type": "array", "items": {"$ref": "#/definitions/AssessmentQuestion"}}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "title": {"title": "Assessment Title", "type": "string", "maxLength": 200, "minLength": 1}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "AssessmentQuestionWrite": {"required": ["slack_markup"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "x-nullable": true}, "position": {"title": "Position", "type": "integer", "maximum": 32767, "minimum": -32768}, "answers": {"type": "array", "items": {"$ref": "#/definitions/AssessmentAnswer"}}, "editor_content": {"$ref": "#/definitions/editor_state_in_question_serializers"}, "image_ids": {"type": "array", "items": {"type": "string", "x-nullable": true}}, "slack_markup": {"title": "Slack markup", "type": "string", "minLength": 1}, "single_select": {"title": "Single select", "type": "boolean"}, "single_correct": {"title": "Single correct", "type": "boolean"}}, "x-nullable": true}, "AssessmentSerializerWrite": {"required": ["title"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "questions": {"type": "array", "items": {"$ref": "#/definitions/AssessmentQuestionWrite"}, "x-nullable": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "title": {"title": "Assessment Title", "type": "string", "maxLength": 200, "minLength": 1}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "TrainingCompanyAssessment": {"required": ["assessment", "company", "curriculum"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "assessment": {"$ref": "#/definitions/Assessment"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "passing_grade": {"title": "Passing grade", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "retake_status": {"title": "Retake status", "type": "string", "enum": ["optional", "force_retake", "force_continue"]}, "is_active": {"title": "Is active", "type": "boolean"}, "position": {"title": "Position", "type": "integer", "maximum": 32767, "minimum": -32768}, "polymorphic_ctype": {"title": "Polymorphic ctype", "type": "integer", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}, "curriculum": {"title": "Curriculum", "type": "string", "format": "uuid"}, "lessons_to_skip": {"type": "array", "items": {"type": "string", "format": "uuid"}, "uniqueItems": true}}}, "TrainingCompanyAssessmentWrite": {"required": ["company", "curriculum", "assessment"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "passing_grade": {"title": "Passing grade", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "retake_status": {"title": "Retake status", "type": "string", "enum": ["optional", "force_retake", "force_continue"]}, "is_active": {"title": "Is active", "type": "boolean"}, "position": {"title": "Position", "type": "integer", "maximum": 32767, "minimum": -32768}, "polymorphic_ctype": {"title": "Polymorphic ctype", "type": "integer", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}, "curriculum": {"title": "Curriculum", "type": "string", "format": "uuid"}, "assessment": {"title": "Assessment", "type": "string", "format": "uuid"}, "lessons_to_skip": {"type": "array", "items": {"type": "string", "format": "uuid"}, "uniqueItems": true}}}, "SlackInstallation": {"required": ["team_id", "bot_token", "bot_id", "bot_user_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "enterprise_id": {"title": "Enterprise id", "type": "string", "maxLength": 255, "x-nullable": true}, "team_id": {"title": "Team id", "type": "string", "maxLength": 255, "minLength": 1}, "bot_token": {"title": "Bot token", "type": "string", "maxLength": 1000, "minLength": 1}, "bot_id": {"title": "Bot id", "type": "string", "maxLength": 255, "minLength": 1}, "bot_user_id": {"title": "Bot user id", "type": "string", "maxLength": 255, "minLength": 1}, "webhook_channel_name": {"title": "Incoming webhook channel name", "type": "string", "maxLength": 255, "x-nullable": true}, "webhook_channel_id": {"title": "Incoming webhook channel id", "type": "string", "maxLength": 255}, "webhook_configuration_url": {"title": "Incoming webhook configuration url", "type": "string", "maxLength": 255, "x-nullable": true}, "webhook_url": {"title": "Incoming webhook url", "type": "string", "maxLength": 255}, "is_uninstalled": {"title": "Is uninstalled", "type": "boolean"}, "last_install_date": {"title": "Last install date", "type": "string", "format": "date-time", "x-nullable": true}}}, "EmployeeWithoutCompanyDetails": {"required": ["name", "email", "slack_uid"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "avatar_image": {"title": "Avatar Image", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "maxLength": 254, "x-nullable": true}, "role": {"title": "Role", "type": "string", "format": "uuid", "x-nullable": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "user": {"title": "User", "type": "string", "format": "uuid", "readOnly": true}, "is_admin": {"title": "Is admin", "type": "boolean"}, "is_manager": {"title": "Is manager", "type": "string", "readOnly": true}, "points": {"title": "Points", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "level": {"title": "Level", "type": "string", "readOnly": true}}}, "TopPerformer": {"required": ["employee"], "type": "object", "properties": {"employee": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}, "completed_percentage": {"title": "Completed percentage", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "completed_trainings": {"title": "Completed trainings", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "EmployeeTrainingManageList": {"required": ["employee", "employee_name", "avatar_image", "employee_slack_uid"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee": {"title": "Employee", "type": "string", "format": "uuid"}, "employee_name": {"title": "Employee name", "type": "string", "minLength": 1}, "avatar_image": {"title": "Avatar image", "type": "string", "minLength": 1}, "employee_slack_uid": {"title": "Employee slack uid", "type": "string", "minLength": 1}, "completed_percentage": {"title": "Completed percentage", "type": "string", "readOnly": true}, "latest_grade": {"title": "Latest grade", "type": "string", "readOnly": true}, "due_date": {"title": "Due_date", "type": "string", "format": "date-time", "x-nullable": true}, "number_of_attempts": {"title": "Number of attempts", "type": "string", "readOnly": true}, "is_attempt_active": {"title": "Is attempt active", "type": "string", "readOnly": true}, "start_date": {"title": "Start_date", "type": "string", "format": "date-time", "readOnly": true}, "is_past_due": {"title": "Is past due", "type": "string", "readOnly": true}}}, "EmployeeManageList": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "readOnly": true, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "readOnly": true, "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "readOnly": true, "minLength": 1}, "avatar_image": {"title": "Avatar Image", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "role": {"title": "Role", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "user": {"title": "User", "type": "string", "format": "uuid", "readOnly": true}, "is_admin": {"title": "Is admin", "type": "boolean", "readOnly": true}, "is_manager": {"title": "Is manager", "type": "string", "readOnly": true}, "points": {"title": "Points", "type": "integer", "readOnly": true}, "level": {"title": "Level", "type": "string", "readOnly": true}}}, "Role": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Title", "type": "string", "maxLength": 60, "x-nullable": true}, "technical": {"title": "Technical", "type": "boolean"}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "Company": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Company name", "type": "string", "readOnly": true, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1, "x-nullable": true}, "slack_workspace": {"title": "Slack workspace", "type": "string", "readOnly": true, "minLength": 1}, "max_users": {"title": "Max users", "type": "string", "readOnly": true}, "plan_title": {"title": "Plan title", "type": "string", "readOnly": true}, "plan_price": {"title": "Plan price", "type": "string", "readOnly": true}, "all_content": {"title": "All content", "type": "string", "readOnly": true}, "custom_content": {"title": "Custom content", "type": "string", "readOnly": true}, "has_workflows": {"title": "Has workflows", "type": "string", "readOnly": true}, "has_paid_streams": {"title": "Has paid streams", "type": "string", "readOnly": true}, "hris_integration": {"title": "Hris integration", "type": "string", "readOnly": true}, "has_vanta": {"title": "Has vanta", "type": "string", "readOnly": true}, "has_api_access": {"title": "Has api access", "type": "string", "readOnly": true}, "has_docebo": {"title": "Has docebo", "type": "string", "readOnly": true}, "has_seismic": {"title": "Has seismic", "type": "string", "readOnly": true}, "has_phishing_access": {"title": "Has phishing access", "type": "string", "readOnly": true}, "icon": {"title": "Company icon", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "domain": {"title": "Slack domain name", "type": "string", "maxLength": 256, "x-nullable": true}, "active_employees_trainings": {"title": "Active employees trainings", "type": "string", "readOnly": true}, "total_employees": {"title": "Total employees", "type": "string", "readOnly": true}, "guest_accounts_included": {"title": "Guest accounts included", "type": "string", "readOnly": true}, "is_global_content_maker": {"title": "Is global content maker", "type": "string", "readOnly": true}}}, "EmployeeNotifications": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "email_notification": {"title": "Email notification", "type": "boolean"}, "slack_notification": {"title": "Slack notification", "type": "boolean"}}}, "Employee": {"required": ["name", "email", "slack_uid", "role_serialized", "company_details", "notifications"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "maxLength": 254, "x-nullable": true}, "role": {"title": "Role", "type": "string", "format": "uuid", "x-nullable": true}, "role_serialized": {"$ref": "#/definitions/Role"}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "user": {"title": "User", "type": "string", "format": "uuid", "readOnly": true}, "is_admin": {"title": "Is admin", "type": "boolean"}, "is_manager": {"title": "Is manager", "type": "string", "readOnly": true}, "company_details": {"$ref": "#/definitions/Company"}, "avatar_image": {"title": "Avatar Image", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "points": {"title": "Points", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "level": {"title": "Level", "type": "string", "readOnly": true}, "notifications": {"$ref": "#/definitions/EmployeeNotifications"}, "google_id": {"title": "Google id", "type": "string", "readOnly": true, "minLength": 1}}}, "GroupMember": {"required": ["name", "email"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}, "avatar_image": {"title": "Avatar Image", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}}}, "Group": {"required": ["name", "manager"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 30, "minLength": 1}, "icon": {"title": "Icon", "type": "string", "maxLength": 30, "x-nullable": true}, "manager": {"$ref": "#/definitions/GroupMember"}, "members": {"type": "array", "items": {"type": "string", "format": "uuid", "x-nullable": true}, "uniqueItems": true}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}, "x-nullable": true}, "channels_to_sync": {"type": "array", "items": {"title": "Channels to sync", "type": "string", "maxLength": 100, "minLength": 1}, "x-nullable": true}, "slack_user_groups": {"type": "array", "items": {"title": "Slack user groups", "type": "string", "maxLength": 100, "minLength": 1}, "x-nullable": true}}}, "EmployeeWeeklyHome": {"required": ["quiz_id", "quiz_title", "send_cycle"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "quiz_id": {"title": "Quiz id", "type": "string", "minLength": 1}, "quiz_title": {"title": "Quiz title", "type": "string", "minLength": 1}, "send_cycle": {"title": "Send cycle", "type": "string", "minLength": 1}, "questions": {"title": "Questions", "type": "string", "readOnly": true}, "progress_status": {"title": "Progress status", "type": "string", "readOnly": true}}}, "SimpleCompanyEngagement": {"required": ["company", "quiz_id", "quiz_title", "channel"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "quiz_id": {"title": "Quiz id", "type": "string", "minLength": 1}, "quiz_title": {"title": "Quiz title", "type": "string", "minLength": 1}, "channel": {"title": "Channel", "type": "string", "minLength": 1}, "questions": {"title": "Questions", "type": "string", "readOnly": true}, "send_cycle": {"title": "Send cycle", "type": "string", "enum": ["once", "weekly", "monthly", "quarterly", "semi-annual", "annual"]}}}, "ListTranignsSerializers": {"required": ["title", "number_of_lessons", "number_of_assessments", "assigment_id", "due_date"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Title", "type": "string", "minLength": 1}, "employees_assigned": {"title": "Employees assigned", "type": "string", "readOnly": true}, "employees_completed": {"title": "Employees completed", "type": "string", "readOnly": true}, "number_of_lessons": {"title": "Number of lessons", "type": "integer"}, "number_of_assessments": {"title": "Number of assessments", "type": "integer"}, "days_till_due": {"title": "Days till due", "type": "number", "x-nullable": true}, "renew_cycle": {"title": "Renew cycle", "type": "string", "enum": ["none", "quarterly", "semi-annual", "annual"]}, "assigment_id": {"title": "Assigment id", "type": "string", "format": "uuid"}, "due_date": {"title": "Due date", "type": "string", "format": "date-time"}, "completed_lessons": {"title": "Completed lessons", "type": "string", "readOnly": true}, "completed_assessments": {"title": "Completed assessments", "type": "string", "readOnly": true}}}, "CompanyHomeData": {"required": ["weeklies", "company_weeklies", "trainings_data", "trainings_count"], "type": "object", "properties": {"weeklies": {"type": "array", "items": {"$ref": "#/definitions/EmployeeWeeklyHome"}}, "company_weeklies": {"type": "array", "items": {"$ref": "#/definitions/SimpleCompanyEngagement"}}, "trainings_data": {"type": "array", "items": {"$ref": "#/definitions/ListTranignsSerializers"}}, "trainings_count": {"title": "Trainings count", "type": "integer"}}}, "CompanyIntegrations": {"required": ["gusto", "okta", "okta_webhook_verified"], "type": "object", "properties": {"gusto": {"title": "Gusto", "type": "boolean"}, "okta": {"title": "Okta", "type": "boolean"}, "okta_webhook_verified": {"title": "Okta webhook verified", "type": "boolean"}}}, "Notifications": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "company_title": {"title": "Company name", "type": "string", "maxLength": 80, "minLength": 1, "x-nullable": true}, "new_users_onboarding": {"title": "New users onboarding", "type": "boolean"}, "new_users_onboarding_admin": {"title": "New users onboarding admin", "type": "boolean"}, "users_completed_training_admin": {"title": "Users completed training admin", "type": "boolean"}, "users_assigned_training_admin": {"title": "Users assigned training admin", "type": "boolean"}, "weekly_report": {"title": "Weekly report", "type": "boolean"}, "overdue_training_reminder": {"title": "Overdue training reminder", "type": "boolean"}, "phishing_messages_admin": {"title": "Phishing messages admin", "type": "boolean"}, "phishing_reminder_to_report": {"title": "Phishing reminder to report", "type": "boolean"}}}, "CompanyNotificationSchedule": {"required": ["company"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "sunday": {"title": "Sunday", "type": "boolean"}, "monday": {"title": "Monday", "type": "boolean"}, "tuesday": {"title": "Tuesday", "type": "boolean"}, "wednesday": {"title": "Wednesday", "type": "boolean"}, "thursday": {"title": "Thursday", "type": "boolean"}, "friday": {"title": "Friday", "type": "boolean"}, "saturday": {"title": "Saturday", "type": "boolean"}, "send_from": {"title": "Send from", "type": "string"}, "send_to": {"title": "Send to", "type": "string"}, "active": {"title": "Active", "type": "boolean"}, "company": {"title": "Company", "type": "string", "format": "uuid"}}}, "PhishingTemplateCategory": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 50, "minLength": 1}}}, "PhishingTemplate": {"required": ["name", "preview_image_url", "html_url", "sender_email_address", "category"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "application": {"title": "Application", "type": "string", "maxLength": 30, "x-nullable": true}, "name": {"title": "Name", "type": "string", "maxLength": 255, "minLength": 1}, "icon": {"title": "Icon", "type": "string", "maxLength": 255, "x-nullable": true}, "preview_image_url": {"title": "Preview image url", "type": "string", "maxLength": 255, "minLength": 1}, "html_url": {"title": "Html url", "type": "string", "maxLength": 255, "minLength": 1}, "active": {"title": "Active", "type": "boolean"}, "sender_email_address": {"title": "Sender email address", "type": "string", "maxLength": 255, "minLength": 1}, "category": {"$ref": "#/definitions/PhishingTemplateCategory"}}}, "PhishingCampaign": {"required": ["name", "templates"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "active": {"title": "Active", "type": "boolean"}, "name": {"title": "Name", "type": "string", "maxLength": 30, "minLength": 1}, "templates": {"type": "array", "items": {"$ref": "#/definitions/PhishingTemplate"}}, "send_option": {"title": "Send option", "type": "string", "enum": ["once_immediately", "randomly_once_every_two_weeks", "randomly_once_monthly", "randomly_once_quarterly", "randomly_once_every_six_months", "randomly_once_yearly"], "x-nullable": true}, "skip_weekends": {"title": "Skip weekends", "type": "boolean"}, "last_sent_date": {"title": "Last sent date", "type": "string", "format": "date-time", "x-nullable": true}, "channels_to_sync": {"type": "array", "items": {"title": "Channels to sync", "type": "string", "maxLength": 100, "minLength": 1}, "x-nullable": true}, "slack_auto_enroll": {"title": "Slack auto enroll", "type": "boolean", "x-nullable": true}}}, "MinimalEmployee": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "readOnly": true, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "readOnly": true, "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "readOnly": true, "minLength": 1}, "avatar_image": {"title": "Avatar Image", "type": "string", "format": "uri", "readOnly": true, "minLength": 1}}}, "PhishingCampaignAttack": {"required": ["template"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "template": {"$ref": "#/definitions/PhishingTemplate"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "report_rate": {"title": "Report rate", "type": "string", "readOnly": true}}}, "PhishingCampaignAction": {"required": ["employee", "attack", "action_type", "points"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee": {"$ref": "#/definitions/MinimalEmployee"}, "attack": {"$ref": "#/definitions/PhishingCampaignAttack"}, "action_type": {"title": "Action type", "type": "string", "enum": ["report_phishing", "do_nothing", "open_phishing_mail", "click_phishing_link", "breach_credentials", "forwarded_phishing_mail"]}, "points": {"title": "Points", "type": "integer", "enum": [100, 50, 20, 10, 0]}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "priority": {"title": "Priority", "type": "integer", "enum": [5, 4, 3, 2, 1], "x-nullable": true}}}, "PhishingCompanySettings": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "forwarding_emails": {"type": "array", "items": {"title": "Forwarding emails", "type": "string", "maxLength": 255, "minLength": 1}, "x-nullable": true}, "phishing_email_forwarded_notification_emails": {"type": "array", "items": {"title": "Phishing email forwarded notification emails", "type": "string", "maxLength": 255, "minLength": 1}, "x-nullable": true}, "imap_ssl_host": {"title": "Imap ssl host", "type": "string", "maxLength": 255, "x-nullable": true}, "imap_ssl_port": {"title": "Imap ssl port", "type": "string", "maxLength": 255, "x-nullable": true}}}, "TrainingStats": {"required": ["active_trainings", "employee_completed_trainings", "employee_completed_trainings_30", "employee_completed_trainings_30_60", "employee_finished_lesson", "employee_finished_lesson_30", "employee_finished_lesson_30_60", "total_employees", "employees_with_training_assigned", "past_due_trainings"], "type": "object", "properties": {"active_trainings": {"title": "Active trainings", "type": "integer"}, "employee_completed_trainings": {"title": "Employee completed trainings", "type": "integer"}, "employee_completed_trainings_30": {"title": "Employee completed trainings 30", "type": "integer"}, "employee_completed_trainings_30_60": {"title": "Employee completed trainings 30 60", "type": "integer"}, "employee_finished_lesson": {"title": "Employee finished lesson", "type": "integer"}, "employee_finished_lesson_30": {"title": "Employee finished lesson 30", "type": "integer"}, "employee_finished_lesson_30_60": {"title": "Employee finished lesson 30 60", "type": "integer"}, "total_employees": {"title": "Total employees", "type": "integer"}, "employees_with_training_assigned": {"title": "Employees with training assigned", "type": "integer"}, "past_due_trainings": {"title": "Past due trainings", "type": "integer"}}}, "Owner": {"required": ["id", "name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}}}, "CompanyStream": {"required": ["company", "stream", "owners"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "stream": {"title": "Stream", "type": "string", "format": "uuid"}, "is_active": {"title": "Is active", "type": "boolean"}, "review_posts": {"title": "Review posts", "type": "boolean"}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "posts_in_queue": {"title": "Posts in queue", "type": "string", "readOnly": true}, "posts_sent": {"title": "Posts sent", "type": "string", "readOnly": true}, "owners": {"type": "array", "items": {"$ref": "#/definitions/Owner"}}}}, "StreamPostCategory": {"required": ["title"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "maxLength": 60, "minLength": 1}}}, "ContentImage": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "image_name": {"title": "Image Name", "type": "string", "maxLength": 200, "x-nullable": true}, "image_url": {"title": "Image url", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "image_url_public": {"title": "Image url public", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "editor_content": {"title": "Editor Content", "type": "string", "format": "uuid", "x-nullable": true}}}, "RichTextEditorState": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "editor_state": {"title": "Stringified Editor state", "type": "string", "x-nullable": true}, "content": {"type": "array", "items": {"$ref": "#/definitions/ContentImage"}}}}, "StreamPost": {"required": ["title", "post_content", "stream"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "category": {"$ref": "#/definitions/StreamPostCategory"}, "editor_content": {"$ref": "#/definitions/RichTextEditorState"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "title": {"title": "Title", "type": "string", "maxLength": 300, "minLength": 1}, "video_url": {"title": "Video ULR", "type": "string", "maxLength": 300, "x-nullable": true}, "post_content": {"title": "Post content", "type": "string", "minLength": 1}, "send_to_admins_only": {"title": "Send To Admins Only", "type": "boolean"}, "send_time": {"title": "Send time", "type": "string", "format": "date-time", "x-nullable": true}, "send_now": {"title": "Send Now", "type": "boolean"}, "is_sent": {"title": "Is Sent", "type": "boolean"}, "acknowledge_button": {"title": "Acknowledge Button", "type": "boolean"}, "include_rating": {"title": "Include Rating", "type": "boolean"}, "is_editable": {"title": "Is Editable (by Admins)", "type": "boolean"}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "stream": {"title": "Parent Stream", "type": "string", "format": "uuid"}, "stream_post_category": {"title": "Category", "type": "string", "format": "uuid", "x-nullable": true}}}, "CompanyStreamPostWithStatistics": {"required": ["company_stream", "post"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company_stream": {"title": "Company stream", "type": "string", "format": "uuid"}, "post": {"$ref": "#/definitions/StreamPost"}, "global_post_id": {"title": "Global post ID", "type": "string", "maxLength": 50, "x-nullable": true}, "send_admins_message": {"title": "Send admins message", "type": "boolean"}, "is_sent_for_review": {"title": "Is sent for review", "type": "boolean"}, "sent_for_review_time": {"title": "Sent for review time", "type": "string", "format": "date-time", "x-nullable": true}, "approval_status": {"title": "Approval status", "type": "string", "enum": ["none", "approved", "skipped"]}, "updated_by_admin": {"title": "Updated By", "type": "string", "maxLength": 150}, "delivered": {"title": "Delivered", "type": "string", "readOnly": true}, "voted": {"title": "Voted", "type": "string", "readOnly": true}, "rate": {"title": "Rate", "type": "string", "readOnly": true}, "ack": {"title": "Ack", "type": "string", "readOnly": true}}}, "CompanyStreamPost": {"required": ["company_stream", "post"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company_stream": {"title": "Company stream", "type": "string", "format": "uuid"}, "post": {"$ref": "#/definitions/StreamPost"}, "global_post_id": {"title": "Global post ID", "type": "string", "maxLength": 50, "x-nullable": true}, "send_admins_message": {"title": "Send admins message", "type": "boolean"}, "is_sent_for_review": {"title": "Is sent for review", "type": "boolean"}, "sent_for_review_time": {"title": "Sent for review time", "type": "string", "format": "date-time", "x-nullable": true}, "approval_status": {"title": "Approval status", "type": "string", "enum": ["none", "approved", "skipped"]}, "updated_by_admin": {"title": "Updated By", "type": "string", "maxLength": 150}}}, "CompanyAPIKey": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "description": "A free-form name for the API key. Need not be unique. 50 characters max.", "type": "string", "maxLength": 50, "minLength": 1}, "created": {"title": "Created", "type": "string", "format": "date-time", "readOnly": true}}}, "SimpleQuestion": {"required": ["title", "explanation", "lesson", "answers"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Lesson Scenario Content", "description": "You must use the Slack nomenclature for\n        the markdown, for more info visit:\n        https://api.slack.com/reference/surfaces/formatting", "type": "string", "minLength": 1}, "explanation": {"title": "Lesson Scenario Explanation", "type": "string", "format": "uri", "maxLength": 200, "minLength": 1}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "lesson": {"title": "Lesson", "type": "string", "format": "uuid"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuestionAnswer"}}, "type": {"title": "Lesson Type", "type": "string", "enum": ["multi_select", "multi_choice"]}}}, "lesson_image_in_lesson_serializers": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "image_name": {"title": "Image Name", "type": "string", "maxLength": 200, "x-nullable": true}, "image_url": {"title": "Image url", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "image_url_public": {"title": "Image url public", "type": "string", "readOnly": true, "x-nullable": true, "format": "uri"}, "editor_content": {"title": "Editor Content", "type": "string", "format": "uuid", "x-nullable": true}, "content_type": {"title": "Content Type", "type": "string", "enum": ["lesson", "quiz", "engagement_question", "engagement_message", "assessment_question_content"], "x-nullable": true}}}, "editor_state_in_lesson_serializers": {"required": ["content"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "note_editor_state": {"title": "Stringified note Editor's content", "type": "string", "x-nullable": true}, "summary_editor_state": {"title": "Stringified summary Editor's content", "type": "string", "x-nullable": true}, "question_editor_state": {"title": "Stringified question Editor's content", "type": "string", "x-nullable": true}, "quiz_editor_state": {"title": "Stringified quiz Editor's content", "type": "string", "x-nullable": true}, "quiz_message_state": {"title": "Stringified quiz message Editor's content", "type": "string", "x-nullable": true}, "content": {"type": "array", "items": {"$ref": "#/definitions/lesson_image_in_lesson_serializers"}}}}, "SimpleLesson": {"required": ["editor_content"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Lesson Title", "type": "string", "readOnly": true, "minLength": 1}, "subtitle": {"title": "Lesson Subtitle", "type": "string", "maxLength": 200}, "note": {"title": "Lesson Description", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}, "summary": {"title": "Lesson Content", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}, "help_content": {"title": "Help Content (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "written_content": {"title": "External Resources (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "explanation_content": {"title": "Explanation Content (URL)", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "questions": {"type": "array", "items": {"$ref": "#/definitions/SimpleQuestion"}}, "video_url": {"title": "Video URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "video_position": {"title": "Video position", "type": "string", "enum": ["bottom", "top"]}, "includes_video": {"title": "Includes video", "type": "boolean"}, "show_to_browser_link_in_slack": {"title": "Show to browser link in slack", "type": "boolean"}, "employees_assigned": {"title": "Employees assigned", "type": "string", "readOnly": true}, "employees_finished": {"title": "Employees finished", "type": "string", "readOnly": true}, "editor_content": {"$ref": "#/definitions/editor_state_in_lesson_serializers"}, "is_simple_form": {"title": "Is Simple Lesson", "type": "boolean"}, "lesson_custom_video": {"type": "array", "items": {"$ref": "#/definitions/CustomLessonVideo"}}, "average_length": {"title": "Average length", "type": "string", "readOnly": true}}}, "TrainingTag": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Training tag name", "type": "string", "maxLength": 60, "minLength": 1}}, "x-nullable": true}, "GroupWithMinimalData": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Name", "type": "string", "maxLength": 30, "minLength": 1}, "icon": {"title": "Icon", "type": "string", "maxLength": 30, "x-nullable": true}}}, "TrainingSerializerCompany": {"required": ["company", "curriculum", "renew_date", "lessons", "groups"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "company_details": {"$ref": "#/definitions/Company"}, "curriculum": {"title": "Curriculum", "type": "string", "minLength": 1}, "annual": {"title": "Annual", "type": "boolean"}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "renew_date": {"title": "Renew date", "type": "string", "format": "date"}, "end_date": {"title": "End date", "type": "string", "format": "date-time", "x-nullable": true}, "days_till_due": {"title": "Days till due", "type": "number", "x-nullable": true}, "active": {"title": "Active", "type": "boolean"}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}, "curriculum_detail": {"$ref": "#/definitions/Curriculum"}, "creator_slack_uid": {"title": "Creator slack uid", "type": "string", "readOnly": true}, "total_employees": {"title": "Total employees", "type": "string", "readOnly": true}, "employees_finished_count": {"title": "Employees finished count", "type": "string", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "auto_enroll_google": {"title": "Auto enroll google", "type": "boolean"}, "renew_cycle": {"title": "Renew cycle", "type": "string", "enum": ["none", "quarterly", "semi-annual", "annual"]}, "obey_assignment_dates": {"title": "Obey assignment dates", "type": "boolean"}, "passing_grade": {"title": "Passing grade", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "curriculum_type": {"title": "Curriculum type", "type": "string", "format": "uuid"}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}, "lessons": {"type": "array", "items": {"$ref": "#/definitions/SimpleLesson"}}, "tags": {"type": "array", "items": {"$ref": "#/definitions/TrainingTag"}, "readOnly": true, "x-nullable": true}, "groups": {"type": "array", "items": {"$ref": "#/definitions/GroupWithMinimalData"}}, "show_correctness_indicator_on_results": {"title": "Show correctness indicator on results", "type": "boolean"}}}, "DoceboTrainingManagerNotifications": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "is_over_due_on": {"title": "Is over due on", "type": "boolean"}, "over_due_schedule": {"title": "Over due schedule", "type": "string", "enum": ["daily", "weekly", "monthly"]}, "docebo_training_connector": {"title": "Docebo training connector", "type": "string", "format": "uuid", "x-nullable": true}}}, "DoceboTrainingConnector": {"required": ["docebo_manager_notifications", "course_id", "code", "uidCourse", "title", "type", "training"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "docebo_manager_notifications": {"$ref": "#/definitions/DoceboTrainingManagerNotifications"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "course_id": {"title": "Course id", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "code": {"title": "Code", "type": "string", "maxLength": 100, "minLength": 1}, "uidCourse": {"title": "UidCourse", "type": "string", "maxLength": 100, "minLength": 1}, "title": {"title": "Title", "type": "string", "maxLength": 256, "minLength": 1}, "type": {"title": "Type", "type": "string", "maxLength": 100, "minLength": 1}, "training": {"title": "Training", "type": "string", "format": "uuid"}}, "x-nullable": true}, "CustomMessage": {"required": ["editor_content"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "editor_content": {"$ref": "#/definitions/RichTextEditorState"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "enabled": {"title": "Enabled", "type": "boolean"}, "slack_markup": {"title": "Slack Markup", "type": "string", "x-nullable": true}, "polymorphic_ctype": {"title": "Polymorphic ctype", "type": "integer", "readOnly": true}}, "x-nullable": true}, "Training": {"required": ["curriculum", "renew_date", "lessons", "groups", "docebo_course"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "curriculum": {"title": "Curriculum", "type": "string", "minLength": 1}, "annual": {"title": "Annual", "type": "boolean"}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "end_date": {"title": "End date", "type": "string", "format": "date-time", "x-nullable": true}, "renew_date": {"title": "Renew date", "type": "string", "format": "date"}, "renew_cycle": {"title": "Renew cycle", "type": "string", "enum": ["none", "quarterly", "semi-annual", "annual"]}, "days_till_due": {"title": "Days till due", "type": "number", "x-nullable": true}, "active": {"title": "Active", "type": "boolean", "readOnly": true}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}, "curriculum_detail": {"$ref": "#/definitions/Curriculum"}, "creator_slack_uid": {"title": "Creator slack uid", "type": "string", "readOnly": true}, "total_employees": {"title": "Total employees", "type": "string", "readOnly": true}, "employees_finished_count": {"title": "Employees finished count", "type": "string", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "obey_assignment_dates": {"title": "Obey assignment dates", "type": "boolean"}, "passing_grade": {"title": "Passing grade", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "curriculum_type": {"title": "Curriculum type", "type": "string", "format": "uuid"}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}, "lessons": {"type": "array", "items": {"$ref": "#/definitions/SimpleLesson"}}, "tags": {"type": "array", "items": {"$ref": "#/definitions/TrainingTag"}, "readOnly": true, "x-nullable": true}, "groups": {"type": "array", "items": {"$ref": "#/definitions/GroupWithMinimalData"}}, "docebo_course": {"$ref": "#/definitions/DoceboTrainingConnector"}, "show_correctness_indicator_on_results": {"title": "Show correctness indicator on results", "type": "boolean"}, "custom_enrollment_message": {"$ref": "#/definitions/CustomMessage"}}}, "RenewedTraining": {"required": ["curriculum"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "end_date": {"title": "End date", "type": "string", "format": "date-time", "x-nullable": true}, "renew_date": {"title": "Renew date", "type": "string", "format": "date", "x-nullable": true}, "renew_cycle": {"title": "Renew cycle", "type": "string", "enum": ["none", "quarterly", "semi-annual", "annual"]}, "active": {"title": "Active", "type": "boolean", "readOnly": true}, "curriculum": {"title": "Curriculum", "type": "string", "format": "uuid"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}}}, "EmployeeGetBeforeEditTraining": {"required": ["slack_uid"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "slack_uid": {"title": "Slack uid", "type": "string", "minLength": 1}}}, "TrainingGetBeforeEdit": {"required": ["renew_date", "curriculum_title", "employees"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "annual": {"title": "Annual", "type": "boolean", "readOnly": true}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "readOnly": true}, "end_date": {"title": "End date", "type": "string", "format": "date-time", "readOnly": true}, "renew_date": {"title": "Renew date", "type": "string", "format": "date"}, "days_till_due": {"title": "Days till due", "type": "number", "readOnly": true}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "employees": {"type": "array", "items": {"$ref": "#/definitions/EmployeeGetBeforeEditTraining"}}, "auto_enroll": {"title": "Auto enroll", "type": "boolean", "readOnly": true}}}, "TrainingList": {"required": ["curriculum_subtitle", "curriculum_title", "is_onboarding"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "curriculum_subtitle": {"title": "Curriculum subtitle", "type": "string", "minLength": 1}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "is_onboarding": {"title": "Is onboarding", "type": "boolean"}, "average_length": {"title": "Average length", "type": "string", "readOnly": true}}}, "MigrateCurriculumOnTrainingRenew": {"required": ["renewal_date", "new_curriculum_title", "number_of_assigned_employees", "obey_assignment_dates"], "type": "object", "properties": {"renewal_date": {"title": "Renewal date", "type": "string", "minLength": 1}, "new_curriculum_title": {"title": "New curriculum title", "type": "string", "minLength": 1}, "number_of_assigned_employees": {"title": "Number of assigned employees", "type": "integer"}, "obey_assignment_dates": {"title": "Obey assignment dates", "type": "boolean"}}}, "TrainingStatistics": {"type": "object", "properties": {"all_employees_alerted_in_slack": {"title": "All employees alerted in slack", "type": "string", "readOnly": true}, "employees_without_slack": {"title": "Employees without slack", "type": "string", "readOnly": true}}}, "UserAccountsSettings": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "guest_accounts_included": {"title": "Guest accounts included", "type": "boolean"}, "keep_guest_accounts": {"title": "Keep guest accounts in db", "type": "boolean"}, "google_auto_sync": {"title": "Auto sync accounts in Google", "type": "boolean"}, "delete_inactive_users": {"title": "Delete inactive users", "type": "boolean"}, "is_user_role_optional": {"title": "Is user role optional", "type": "boolean"}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "WorkflowList": {"required": ["event", "can_be_supressed"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company_id": {"title": "Company id", "type": "string", "readOnly": true}, "event_source": {"title": "Event source", "type": "string", "readOnly": true}, "event_destination": {"title": "Event destination", "type": "string", "readOnly": true}, "action": {"title": "Action", "type": "string", "readOnly": true}, "event": {"title": "Event", "type": "string", "minLength": 1}, "can_be_supressed": {"title": "Can be supressed", "type": "boolean"}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}}}, "Action": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "payload": {"title": "Payload", "type": "string", "readOnly": true}, "name": {"title": "Name", "type": "string", "readOnly": true}, "sentiment": {"title": "Sentiment", "type": "string", "enum": ["negative", "neutral", "positive"], "readOnly": true}}}, "CompanyEvent": {"required": ["event_id", "event_name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "event_id": {"title": "Event id", "type": "string", "format": "uuid"}, "event_name": {"title": "Event name", "type": "string", "minLength": 1}, "risk_level": {"title": "Risk level", "type": "string", "enum": ["none", "low", "medium", "high"]}}}, "Workflow": {"required": ["action", "event", "can_be_supressed"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company_id": {"title": "Company id", "type": "string", "readOnly": true}, "event_source": {"title": "Event source", "type": "string", "readOnly": true}, "event_destination": {"title": "Event destination", "type": "string", "readOnly": true}, "action": {"$ref": "#/definitions/Action"}, "event": {"$ref": "#/definitions/CompanyEvent"}, "can_be_supressed": {"title": "Can be supressed", "type": "boolean"}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}}}, "CurriculumTag": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "name": {"title": "Curriculum tag name", "type": "string", "maxLength": 60, "minLength": 1}}}, "CurriculumTypeWithoutTitles": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Curriculum type name", "type": "string", "maxLength": 60, "minLength": 1}}}, "CurriculumContent": {"required": ["assessments"], "type": "object", "properties": {"lessons": {"title": "Lessons", "type": "string", "readOnly": true}, "assessments": {"type": "array", "items": {"$ref": "#/definitions/TrainingCompanyAssessment"}}}}, "GlobalCurriculum": {"required": ["title", "subtitle", "curriculum_type"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Training Title", "type": "string", "maxLength": 150, "minLength": 1}, "subtitle": {"title": "Training Subtitle", "type": "string", "maxLength": 255, "minLength": 1}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "curriculum_type": {"title": "Category", "type": "string", "format": "uuid"}, "training_sample": {"title": "Training Sample URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "is_technical": {"title": "Is technical", "type": "boolean"}, "is_archived": {"title": "Is archived", "type": "boolean"}, "is_published": {"title": "Is published", "type": "boolean"}, "is_editable": {"title": "Is editable", "type": "boolean"}, "is_available_for_free": {"title": "Is available for free", "type": "boolean"}, "action_id": {"title": "Answer Action Id", "type": "string", "enum": ["lesson_submit", "branching"]}, "author_name": {"title": "Author Name", "type": "string", "maxLength": 255, "x-nullable": true}, "author_icon_url": {"title": "Author Icon URL", "type": "string", "maxLength": 255, "x-nullable": true}, "tags": {"type": "array", "items": {"$ref": "#/definitions/CurriculumTag"}, "readOnly": true, "x-nullable": true}}}, "EmployeeEngagementsResultsEmployeeData": {"required": ["id", "slack_uid", "name", "avatar_image"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "minLength": 1}, "name": {"title": "Name", "type": "string", "minLength": 1}, "avatar_image": {"title": "Avatar image", "type": "string", "minLength": 1}}}, "EmployeeChannelEngagementResults": {"required": ["employee", "acknowledged"], "type": "object", "properties": {"employee": {"$ref": "#/definitions/EmployeeEngagementsResultsEmployeeData"}, "acknowledged": {"title": "Acknowledged", "type": "boolean"}}}, "EmailInvitation": {"required": ["email"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "email": {"title": "Email", "type": "string", "maxLength": 50, "minLength": 1}, "status": {"title": "Status", "type": "string", "enum": ["INVITED", "CONFIRMED", "DONE"]}, "is_admin": {"title": "Is admin", "type": "boolean"}}}, "EmployeeLessonAttempt": {"required": ["lesson", "employee_training_attempt", "employee_lesson"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "lesson": {"title": "Lesson", "type": "string", "minLength": 1}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "earned_score": {"title": "Earned score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "possible_score": {"title": "Possible score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "selected_answers": {"title": "Selected answers", "type": "string", "maxLength": 10000, "x-nullable": true}, "answers_snapshot": {"title": "Answers snapshot", "type": "string", "maxLength": 10000, "x-nullable": true}, "employee_training_attempt": {"title": "Employee training attempt", "type": "string", "format": "uuid"}, "employee_lesson": {"title": "Employee lessons", "type": "string", "format": "uuid"}, "question": {"title": "Question", "type": "string", "format": "uuid", "x-nullable": true}}}, "EmployeeLogin": {"required": ["name", "email", "slack_uid", "company_max_users", "company_plan_title", "company_plan_price"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}, "slack_uid": {"title": "Slack uid", "type": "string", "maxLength": 254, "x-nullable": true}, "role": {"title": "Role", "type": "string", "format": "uuid", "x-nullable": true}, "role_title": {"title": "Role title", "type": "string", "minLength": 1}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "is_admin": {"title": "Is admin", "type": "boolean"}, "is_manager": {"title": "Is manager", "type": "string", "readOnly": true}, "company_max_users": {"title": "Company max users", "type": "integer"}, "company_plan_title": {"title": "Company plan title", "type": "string", "minLength": 1}, "company_plan_price": {"title": "Company plan price", "type": "integer"}, "points": {"title": "Points", "type": "integer", "readOnly": true}, "level": {"title": "Level", "type": "string", "readOnly": true}, "company_title": {"title": "Company title", "type": "string", "readOnly": true}, "slack_team_id": {"title": "Slack team id", "type": "string", "readOnly": true}, "guest_accounts_included": {"title": "Guest accounts included", "type": "string", "readOnly": true}, "google_id": {"title": "Google id", "type": "string", "readOnly": true, "minLength": 1}, "user_type": {"title": "User type", "type": "string", "enum": ["slack", "google"], "readOnly": true}}}, "EmployeeEngagementQuestionAnonymousResponse": {"required": ["anonymous_response", "question"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "answers": {"title": "Answers", "type": "object", "x-nullable": true}, "written_answer": {"title": "Written answer", "type": "string", "x-nullable": true}, "anonymous_response": {"title": "Anonymous response", "type": "string", "format": "uuid"}, "question": {"title": "Question", "type": "string", "format": "uuid"}}}, "EmployeeEngagementsAnonymousResponses": {"required": ["question_responses", "engagement"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "question_responses": {"type": "array", "items": {"$ref": "#/definitions/EmployeeEngagementQuestionAnonymousResponse"}}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "schedule_id": {"title": "Schedule id", "type": "string", "maxLength": 50}, "hashed_user_id": {"title": "Hashed user id", "type": "string", "maxLength": 30}, "engagement": {"title": "Engagement", "type": "string", "format": "uuid"}}}, "EmployeeWeeklyBulkOpen": {"required": ["results", "error", "error_message"], "type": "object", "properties": {"results": {"title": "Results", "type": "string", "minLength": 1}, "error": {"title": "Error", "type": "boolean"}, "error_message": {"title": "Error message", "type": "string", "minLength": 1}}}, "QuizQuestionAnswer": {"required": ["answer"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "answer": {"title": "Answer", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "maxLength": 150, "minLength": 1}, "position": {"title": "Order", "type": "integer", "maximum": 32767, "minimum": -32768}, "correct": {"title": "Correct", "type": "boolean", "x-nullable": true}, "explanation": {"title": "Answer Explanation", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}, "question": {"title": "Question", "type": "string", "format": "uuid", "readOnly": true}}}, "CustomEngagementQuestionVideo": {"required": ["name", "progress", "thumbnail"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "engagement_question": {"title": "Engagement", "type": "string", "format": "uuid", "x-nullable": true}, "service_id": {"title": "Service ID", "type": "integer", "readOnly": true}, "name": {"title": "Video Title", "type": "string", "maxLength": 300, "minLength": 1}, "duration": {"title": "Duration", "type": "integer", "readOnly": true}, "hashed_id": {"title": "Hashed id", "type": "string", "readOnly": true}, "progress": {"title": "Progress", "type": "string", "format": "decimal"}, "thumbnail": {"title": "Thumbnail", "type": "string", "maxLength": 500, "minLength": 1}, "processed": {"title": "Processed", "type": "boolean"}, "plays": {"title": "Plays", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "QuizQuestion": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuizQuestionAnswer"}}, "editor_content": {"$ref": "#/definitions/editor_state_in_lesson_serializers"}, "quiz_question_context": {"title": "Quiz question context", "type": "string", "readOnly": true}, "engagement_custom_video": {"type": "array", "items": {"$ref": "#/definitions/CustomEngagementQuestionVideo"}}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "answer_type": {"title": "Answer type", "type": "string", "enum": ["no_action", "user_acknowledged", "multiple_choice", "neutral", "written_response", "external_url"], "x-nullable": true}, "external_url": {"title": "External URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "external_url_btn_text": {"title": "External URL button text", "type": "string", "x-nullable": true}, "single_select": {"title": "Single select", "type": "boolean"}, "quiz": {"title": "Quiz", "type": "string", "format": "uuid", "readOnly": true}}}, "ChannelEngagement": {"required": ["message_ts", "channel", "engagement"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "video_ts": {"title": "Video ts", "type": "string", "maxLength": 30, "x-nullable": true}, "message_ts": {"title": "Message ts", "type": "string", "maxLength": 30, "minLength": 1}, "channel": {"title": "Channel", "type": "string", "maxLength": 20, "minLength": 1}, "schedule_id": {"title": "Schedule id", "type": "string", "maxLength": 50}, "engagement": {"title": "Engagement", "type": "string", "format": "uuid"}}}, "WeeklyQuiz": {"required": ["channel_engagements"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Title", "type": "string", "maxLength": 200, "x-nullable": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "engagement_type": {"title": "Engagement Type", "type": "string", "enum": ["private", "channel"]}, "mention_channel": {"title": "Mention channel", "type": "boolean"}, "channel": {"title": "Channel", "type": "string", "maxLength": 20, "minLength": 1, "x-nullable": true}, "questions": {"type": "array", "items": {"$ref": "#/definitions/QuizQuestion"}}, "channel_engagements": {"type": "array", "items": {"$ref": "#/definitions/ChannelEngagement"}}, "anonymize_user_results": {"title": "Anonymize user results", "type": "boolean"}}}, "EngagementWelcomeMessage": {"required": ["editor_content", "engagement"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "editor_content": {"$ref": "#/definitions/RichTextEditorState"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "enabled": {"title": "Enabled", "type": "boolean"}, "slack_markup": {"title": "Slack Markup", "type": "string", "x-nullable": true}, "button_text": {"title": "Button text", "type": "string", "maxLength": 50, "minLength": 1}, "polymorphic_ctype": {"title": "Polymorphic ctype", "type": "integer", "readOnly": true}, "engagement": {"title": "Engagement", "type": "string", "format": "uuid"}}}, "EngagementClosingMessage": {"required": ["editor_content", "engagement"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "editor_content": {"$ref": "#/definitions/RichTextEditorState"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "enabled": {"title": "Enabled", "type": "boolean"}, "slack_markup": {"title": "Slack Markup", "type": "string", "x-nullable": true}, "show_review_option": {"title": "Show review option", "type": "boolean"}, "polymorphic_ctype": {"title": "Polymorphic ctype", "type": "integer", "readOnly": true}, "engagement": {"title": "Engagement", "type": "string", "format": "uuid"}}}, "CompanyWeeklyQuiz": {"required": ["quiz", "welcome_message", "closing_message", "company"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "quiz": {"$ref": "#/definitions/WeeklyQuiz"}, "next_renew_date": {"title": "Next renew date", "type": "string", "readOnly": true}, "start_date_for_dynamic_engagement": {"title": "Start date for dynamic engagement", "type": "string", "readOnly": true}, "owners": {"type": "array", "items": {"$ref": "#/definitions/Owner"}}, "welcome_message": {"$ref": "#/definitions/EngagementWelcomeMessage"}, "closing_message": {"$ref": "#/definitions/EngagementClosingMessage"}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "active": {"title": "Active", "type": "boolean"}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}, "okta_groups_sync": {"type": "array", "items": {"title": "Okta groups sync", "type": "string", "maxLength": 200, "minLength": 1}}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "send_cycle": {"title": "Send cycle", "type": "string", "enum": ["once", "weekly", "monthly", "quarterly", "semi-annual", "annual"]}, "respect_users_tz": {"title": "Respect users tz", "type": "boolean"}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}}}, "EmployeeWeeklyQuestion": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finished": {"title": "Finished", "type": "boolean"}, "correct": {"title": "Correct", "type": "boolean"}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "answers": {"title": "Answers", "type": "object", "x-nullable": true}, "written_answer": {"title": "Written answer", "type": "string", "x-nullable": true}, "acknowledged": {"title": "Acknowledged", "type": "boolean"}, "employee_quiz": {"title": "Employee quiz question", "type": "string", "format": "uuid", "x-nullable": true}, "question": {"title": "Quiz question", "type": "string", "format": "uuid", "x-nullable": true}}}, "EmployeeWeekly": {"required": ["employee", "weekly", "active_question", "questions"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee": {"$ref": "#/definitions/EmployeeWithoutCompanyDetails"}, "weekly": {"$ref": "#/definitions/CompanyWeeklyQuiz"}, "finished": {"title": "Finished", "type": "string", "readOnly": true}, "active": {"title": "Active", "type": "boolean"}, "active_question": {"title": "Active question", "type": "string", "format": "uuid", "x-nullable": true}, "questions": {"type": "array", "items": {"$ref": "#/definitions/EmployeeWeeklyQuestion"}}}}, "EmployeeEngagementsResultsMessagesData": {"required": ["id", "finished", "answers", "written_answer", "acknowledged", "question_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "minLength": 1}, "finished": {"title": "Finished", "type": "boolean"}, "answers": {"title": "Answers", "type": "object"}, "written_answer": {"title": "Written answer", "type": "string", "minLength": 1}, "acknowledged": {"title": "Acknowledged", "type": "boolean"}, "question_id": {"title": "Question id", "type": "string", "minLength": 1}}}, "EmployeeEngagementsResults": {"required": ["employee", "status", "messages", "finish_date", "active", "is_sent", "engagement_id"], "type": "object", "properties": {"employee": {"$ref": "#/definitions/EmployeeEngagementsResultsEmployeeData"}, "status": {"title": "Status", "type": "string", "minLength": 1}, "messages": {"type": "array", "items": {"$ref": "#/definitions/EmployeeEngagementsResultsMessagesData"}}, "finish_date": {"title": "Finish date", "type": "string", "format": "date-time"}, "active": {"title": "Active", "type": "boolean"}, "is_sent": {"title": "Is sent", "type": "boolean"}, "engagement_id": {"title": "Engagement id", "type": "string", "minLength": 1}}}, "EmployeeTrainingBulkOpen": {"required": ["results", "error", "error_message"], "type": "object", "properties": {"results": {"title": "Results", "type": "string", "minLength": 1}, "error": {"title": "Error", "type": "boolean"}, "error_message": {"title": "Error message", "type": "string", "minLength": 1}}}, "EmployeeTraining": {"required": ["curriculum_title"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "year": {"title": "Year", "type": "integer", "maximum": 32767, "minimum": 0}, "start_date": {"title": "Start_date", "type": "string", "format": "date-time", "readOnly": true}, "due_date": {"title": "Due_date", "type": "string", "format": "date-time", "x-nullable": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "active": {"title": "Active", "type": "boolean", "readOnly": true}, "deactivated_date": {"title": "Deactivated_date", "type": "string", "format": "date-time", "readOnly": true}, "active_lesson": {"title": "Active_lesson", "type": "string", "format": "uuid", "x-nullable": true}, "lessons": {"title": "Lessons", "type": "string", "readOnly": true}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "training_items": {"title": "Training items", "type": "string", "readOnly": true}}}, "EmployeeStreamPost": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "ack": {"title": "Ack", "type": "boolean"}, "rate": {"title": "Rate", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "is_sent": {"title": "Is sent", "type": "boolean", "readOnly": true}, "sent_time": {"title": "Sent time", "type": "string", "format": "date-time", "readOnly": true}, "channel": {"title": "Video posted to Channel", "type": "string", "maxLength": 15, "x-nullable": true}, "ts": {"title": "Video posted at", "type": "string", "maxLength": 20, "x-nullable": true}, "skipped": {"title": "Skipped", "type": "boolean"}, "skipped_reason": {"title": "Skipped reason", "type": "string", "enum": ["not_a_slack_user", "inactive_user", "invited_user", "restricted_user"], "x-nullable": true}, "company_post": {"title": "Company stream post", "type": "string", "format": "uuid", "readOnly": true}, "employee": {"title": "Employee", "type": "string", "format": "uuid", "readOnly": true}}}, "EmployeeTrainingAssessmentQuestion": {"required": ["employee_training_assessment"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "assessment_question": {"title": "Assessment question", "type": "string", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "employee_training_assessment": {"title": "Employee training assessment question", "type": "string", "format": "uuid"}}}, "EmployeeAssessmentQuestion": {"required": ["assessment_id", "assessment_title", "employee_question"], "type": "object", "properties": {"assessment_id": {"title": "Assessment id", "type": "string", "minLength": 1}, "assessment_title": {"title": "Assessment title", "type": "string", "minLength": 1}, "employee_question": {"$ref": "#/definitions/EmployeeTrainingAssessmentQuestion"}}}, "EmployeeTrainingAssessmentQuestionAttempt": {"required": ["assessment_question_id", "employee_training_assessment_attempt", "employee_assessment_question"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "assessment_question_id": {"title": "Assessment question id", "type": "string", "minLength": 1}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "earned_score": {"title": "Earned score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "possible_score": {"title": "Possible score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "selected_answers": {"title": "Selected answers", "type": "string", "maxLength": 10000, "x-nullable": true}, "currect_answers_snapshot": {"title": "Currect answers snapshot", "type": "string", "maxLength": 10000, "x-nullable": true}, "employee_training_assessment_attempt": {"title": "Employee training assessment attempt", "type": "string", "format": "uuid"}, "employee_assessment_question": {"title": "Employee assessment question", "type": "string", "format": "uuid"}}}, "EmployeeTrainingAssessmentAttempt": {"required": ["question_attempts", "employee_training_assessment"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "question_attempts": {"type": "array", "items": {"$ref": "#/definitions/EmployeeTrainingAssessmentQuestionAttempt"}}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "training_attempt_id": {"title": "Training attempt id", "type": "string", "maxLength": 50, "x-nullable": true}, "earned_score": {"title": "Earned score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "possible_score": {"title": "Possible score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "did_user_pass": {"title": "Did user pass", "type": "boolean", "x-nullable": true}, "employee_training_assessment": {"title": "Employee training assessment", "type": "string", "format": "uuid"}}}, "EmployeeAssessmentQuestionSummary": {"required": ["position", "number_of_correct_answers_selected", "number_of_correct_answers_total"], "type": "object", "properties": {"position": {"title": "Position", "type": "integer"}, "number_of_correct_answers_selected": {"title": "Number of correct answers selected", "type": "integer"}, "number_of_correct_answers_total": {"title": "Number of correct answers total", "type": "integer"}}}, "EmployeeAssessmentSummary": {"required": ["assessment_title", "score_percentage", "passing_grade", "has_user_passed", "retakes", "is_last_item_in_training", "training_id", "are_lessons_complete", "are_assessments_complete", "questions"], "type": "object", "properties": {"assessment_title": {"title": "Assessment title", "type": "string", "minLength": 1}, "score_percentage": {"title": "Score percentage", "type": "integer"}, "passing_grade": {"title": "Passing grade", "type": "integer"}, "has_user_passed": {"title": "Has user passed", "type": "boolean"}, "retakes": {"title": "Retakes", "type": "string", "minLength": 1, "x-nullable": true}, "is_last_item_in_training": {"title": "Is last item in training", "type": "boolean"}, "training_id": {"title": "Training id", "type": "string", "minLength": 1}, "are_lessons_complete": {"title": "Are lessons complete", "type": "boolean"}, "are_assessments_complete": {"title": "Are assessments complete", "type": "boolean"}, "questions": {"type": "array", "items": {"$ref": "#/definitions/EmployeeAssessmentQuestionSummary"}}}}, "PublishPointsEvent": {"required": ["event"], "type": "object", "properties": {"event": {"title": "Event", "type": "string", "enum": ["OPEN_TRAINING", "COMPLETE_TRAINING", "COMPLETE_LESSON", "RATE_TIP", "DOWNLOAD_CERTIFICATE", "ANSWER_CORRECT", "WEEKLY_QUIZ_ANSWER"]}}}, "EmployeeWeeklyQuizQuestionAndAnswer": {"required": ["response"], "type": "object", "properties": {"employee_weekly": {"$ref": "#/definitions/EmployeeWeekly"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuizQuestionAnswer"}, "readOnly": true}, "response": {"title": "Response", "type": "boolean"}}}, "EmployeeTrainingsWithoutLessons": {"required": ["renew_date", "renew_cycle", "company_training_id", "curriculum_title", "curriculum_action_id"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "year": {"title": "Year", "type": "integer", "maximum": 32767, "minimum": 0}, "start_date": {"title": "Start_date", "type": "string", "format": "date-time", "readOnly": true}, "renew_date": {"title": "Renew date", "type": "string", "minLength": 1}, "renew_cycle": {"title": "Renew cycle", "type": "string", "minLength": 1}, "due_date": {"title": "Due_date", "type": "string", "format": "date-time", "x-nullable": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "active": {"title": "Active", "type": "boolean", "readOnly": true}, "deactivated_date": {"title": "Deactivated_date", "type": "string", "format": "date-time", "readOnly": true}, "completed_percentage": {"title": "Completed percentage", "type": "string", "readOnly": true}, "completed_lessons": {"title": "Completed lessons", "type": "string", "readOnly": true}, "total_lessons": {"title": "Total lessons", "type": "string", "readOnly": true}, "completed_assessments": {"title": "Completed assessments", "type": "string", "readOnly": true}, "total_assessments": {"title": "Total assessments", "type": "string", "readOnly": true}, "company_training_id": {"title": "Company training id", "type": "string", "minLength": 1}, "curriculum_title": {"title": "Curriculum title", "type": "string", "minLength": 1}, "curriculum_action_id": {"title": "Curriculum action id", "type": "string", "minLength": 1}, "total_employees": {"title": "Total employees", "type": "string", "readOnly": true}, "latest_grade": {"title": "Latest grade", "type": "string", "readOnly": true}, "employees_completed_training": {"title": "Employees completed training", "type": "string", "readOnly": true}}}, "EmployeeHomeTraining": {"required": ["curriculum_name", "curriculum_type_name", "employee_id", "annual", "due_date"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "year": {"title": "Year", "type": "integer", "maximum": 32767, "minimum": 0}, "start_date": {"title": "Start_date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "active": {"title": "Active", "type": "boolean", "readOnly": true}, "deactivated_date": {"title": "Deactivated_date", "type": "string", "format": "date-time", "readOnly": true}, "completed_percentage": {"title": "Completed percentage", "type": "string", "readOnly": true}, "training": {"title": "Training", "type": "string", "format": "uuid", "readOnly": true}, "curriculum_name": {"title": "Curriculum name", "type": "string", "minLength": 1}, "curriculum_type_name": {"title": "Curriculum type name", "type": "string", "minLength": 1}, "lessons": {"title": "Lessons", "type": "string", "readOnly": true}, "employee_id": {"title": "Employee id", "type": "string", "minLength": 1}, "annual": {"title": "Annual", "type": "string", "minLength": 1}, "due_date": {"title": "Due date", "type": "string", "format": "date-time"}}}, "EmployeeTrainingAttempt": {"required": ["lesson_attempts", "employee_training"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "lesson_attempts": {"type": "array", "items": {"$ref": "#/definitions/EmployeeLessonAttempt"}}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "finish_date": {"title": "Finish_date", "type": "string", "format": "date-time", "x-nullable": true}, "earned_score": {"title": "Earned score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "possible_score": {"title": "Possible score", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "attempt_number": {"title": "Attempt number", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "did_user_pass": {"title": "Did user pass", "type": "boolean", "x-nullable": true}, "employee_training": {"title": "Employee training", "type": "string", "format": "uuid"}}}, "EmployeeTrainingItems": {"required": ["type", "employee_item_id", "curriculum_item_id", "finished", "title", "position"], "type": "object", "properties": {"type": {"title": "Type", "type": "string", "minLength": 1}, "employee_item_id": {"title": "Employee item id", "type": "string", "minLength": 1}, "curriculum_item_id": {"title": "Curriculum item id", "type": "string", "minLength": 1}, "finished": {"title": "Finished", "type": "boolean"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "position": {"title": "Position", "type": "integer"}, "questions": {"title": "Questions", "type": "string", "readOnly": true}}}, "LessonList": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Lesson Title", "type": "string", "readOnly": true, "minLength": 1}, "subtitle": {"title": "Lesson Subtitle", "type": "string", "readOnly": true, "minLength": 1}, "video_url": {"title": "Video URL", "type": "string", "format": "uri", "readOnly": true, "minLength": 1}, "includes_video": {"title": "Includes video", "type": "boolean", "readOnly": true}, "position": {"title": "Position order", "type": "integer", "readOnly": true}}}, "EmployeeListLesson": {"required": ["employee_training"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee_training": {"title": "Employee lesson", "type": "string", "format": "uuid"}, "lesson": {"$ref": "#/definitions/LessonList"}, "finished": {"title": "Finished", "type": "boolean"}}}, "EVDTEvent": {"required": ["name", "description", "exact_name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "event_source": {"title": "Event source", "type": "string", "enum": ["slack"]}, "name": {"title": "Name", "type": "string", "maxLength": 255, "minLength": 1}, "description": {"title": "Description", "type": "string", "maxLength": 255, "minLength": 1}, "standard_response": {"title": "Standard response", "type": "string", "x-nullable": true}, "exact_name": {"title": "Exact name", "type": "string", "maxLength": 255, "minLength": 1}, "recommended_risk_level": {"title": "Recommended risk level", "type": "string", "enum": ["none", "low", "medium", "high"]}}}, "ExternalAppPolymorphic": {"type": "object", "properties": {}}, "DoceboCourseItem": {"required": ["id", "code", "uidCourse", "title", "type"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "minLength": 1}, "code": {"title": "Code", "type": "string", "minLength": 1}, "uidCourse": {"title": "Uidcourse", "type": "string", "minLength": 1}, "title": {"title": "Title", "type": "string", "minLength": 1}, "type": {"title": "Type", "type": "string", "minLength": 1}}}, "DoceboCourseList": {"required": ["items", "count", "has_more_data", "current_page", "total_count", "total_page_count"], "type": "object", "properties": {"items": {"type": "array", "items": {"$ref": "#/definitions/DoceboCourseItem"}}, "count": {"title": "Count", "type": "integer"}, "has_more_data": {"title": "Has more data", "type": "boolean"}, "current_page": {"title": "Current page", "type": "integer"}, "total_count": {"title": "Total count", "type": "integer"}, "total_page_count": {"title": "Total page count", "type": "integer"}}}, "GoogleGroup": {"required": ["id", "email", "name", "direct_members_count", "description"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "minLength": 1}, "email": {"title": "Email", "type": "string", "minLength": 1}, "name": {"title": "Name", "type": "string", "minLength": 1}, "direct_members_count": {"title": "Direct members count", "type": "string", "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}}, "x-nullable": true}, "GoogleGroupsList": {"required": ["groups"], "type": "object", "properties": {"groups": {"type": "array", "items": {"$ref": "#/definitions/GoogleGroup"}, "x-nullable": true}, "next_page_token": {"title": "Next page token", "type": "string", "minLength": 1}}}, "SeismicContent": {"required": ["resource_type", "id", "title", "is_certification"], "type": "object", "properties": {"resource_type": {"title": "Resource type", "type": "string", "minLength": 1}, "id": {"title": "Id", "type": "integer"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "is_certification": {"title": "Is certification", "type": "boolean"}}}, "SeismicContentList": {"required": ["items"], "type": "object", "properties": {"items": {"type": "array", "items": {"$ref": "#/definitions/SeismicContent"}}}}, "ExternalAppWebhookConfigResponse": {"required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}, "messages": {"type": "array", "items": {"type": "string", "minLength": 1}}}}, "QuestionAnswerWithoutLessonQuestion": {"required": ["answer"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "answer": {"title": "Answer", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "maxLength": 150, "minLength": 1}, "position": {"title": "Order", "type": "integer", "maximum": 32767, "minimum": -32768}, "correct": {"title": "Correct", "type": "boolean"}, "next_lesson": {"title": "Next lesson", "type": "string", "format": "uuid", "x-nullable": true}, "explanation": {"title": "Answer Explanation", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}}}, "QuestionTitleAnswerOnly": {"required": ["title"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "x-nullable": true}, "title": {"title": "Lesson Scenario Content", "description": "You must use the Slack nomenclature for\n        the markdown, for more info visit:\n        https://api.slack.com/reference/surfaces/formatting", "type": "string", "minLength": 1}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuestionAnswerWithoutLessonQuestion"}}, "type": {"title": "Lesson Type", "type": "string", "enum": ["multi_select", "multi_choice"]}}, "x-nullable": true}, "EditorState": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "note_editor_state": {"title": "Stringified note Editor's content", "type": "string", "x-nullable": true}, "summary_editor_state": {"title": "Stringified summary Editor's content", "type": "string", "x-nullable": true}, "question_editor_state": {"title": "Stringified question Editor's content", "type": "string", "x-nullable": true}, "quiz_editor_state": {"title": "Stringified quiz Editor's content", "type": "string", "x-nullable": true}, "quiz_message_state": {"title": "Stringified quiz message Editor's content", "type": "string", "x-nullable": true}}}, "LessonWrite": {"type": "object", "properties": {"question": {"$ref": "#/definitions/QuestionTitleAnswerOnly"}, "title": {"title": "Title", "type": "string"}, "subtitle": {"title": "Subtitle", "type": "string"}, "note": {"title": "Note", "type": "string", "x-nullable": true}, "summary": {"title": "Summary", "type": "string"}, "written_content": {"title": "Written content", "type": "string", "x-nullable": true}, "includes_video": {"title": "Includes video", "type": "boolean", "default": false}, "show_to_browser_link_in_slack": {"title": "Show to browser link in slack", "type": "boolean", "default": true}, "video_url": {"title": "Video url", "type": "string", "x-nullable": true}, "video_position": {"title": "Video position", "type": "string", "x-nullable": true}, "curriculum": {"title": "Curriculum", "type": "string", "format": "uuid"}, "position": {"title": "Position", "type": "integer"}, "editor_content": {"$ref": "#/definitions/EditorState"}, "is_simple_form": {"title": "Is simple form", "type": "boolean", "default": false}}}, "Charge": {"required": ["stripe_id", "customer"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "stripe_id": {"title": "Stripe id", "type": "string", "maxLength": 255, "minLength": 1}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "card_last_4": {"title": "Card last 4", "type": "string", "maxLength": 4}, "card_kind": {"title": "Card kind", "type": "string", "maxLength": 50}, "currency": {"title": "Currency", "type": "string", "maxLength": 10, "minLength": 1}, "amount": {"title": "Amount", "type": "string", "format": "decimal", "x-nullable": true}, "amount_refunded": {"title": "Amount refunded", "type": "string", "format": "decimal", "x-nullable": true}, "description": {"title": "Description", "type": "string"}, "paid": {"title": "Paid", "type": "boolean", "x-nullable": true}, "disputed": {"title": "Disputed", "type": "boolean", "x-nullable": true}, "refunded": {"title": "Refunded", "type": "boolean", "x-nullable": true}, "captured": {"title": "Captured", "type": "boolean", "x-nullable": true}, "fee": {"title": "Fee", "type": "string", "format": "decimal", "x-nullable": true}, "receipt_sent": {"title": "Receipt sent", "type": "boolean"}, "charge_created": {"title": "Charge created", "type": "string", "format": "date-time", "x-nullable": true}, "customer": {"title": "Customer", "type": "integer"}, "invoice": {"title": "Invoice", "type": "integer", "x-nullable": true}}}, "CurrentCustomer": {"required": ["stripe_id"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "has_active_subscription": {"title": "Has active subscription", "type": "string", "readOnly": true}, "can_charge": {"title": "Can charge", "type": "string", "readOnly": true}, "stripe_id": {"title": "Stripe id", "type": "string", "maxLength": 255, "minLength": 1}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "card_fingerprint": {"title": "Card fingerprint", "type": "string", "maxLength": 200}, "card_last_4": {"title": "Card last 4", "type": "string", "maxLength": 4}, "exp_month": {"title": "Exp month", "type": "string", "maxLength": 2}, "exp_year": {"title": "Exp year", "type": "string", "maxLength": 4}, "card_kind": {"title": "Card kind", "type": "string", "maxLength": 50}, "date_purged": {"title": "Date purged", "type": "string", "format": "date-time", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "EventProcessingException": {"required": ["data", "message", "traceback"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "data": {"title": "Data", "type": "string", "minLength": 1}, "message": {"title": "Message", "type": "string", "maxLength": 500, "minLength": 1}, "traceback": {"title": "Traceback", "type": "string", "minLength": 1}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "event": {"title": "Event", "type": "integer", "x-nullable": true}}}, "Event": {"required": ["stripe_id", "kind", "webhook_message"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "event_processing_exceptions": {"type": "array", "items": {"$ref": "#/definitions/EventProcessingException"}, "readOnly": true}, "stripe_id": {"title": "Stripe id", "type": "string", "maxLength": 255, "minLength": 1}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "kind": {"title": "Kind", "type": "string", "maxLength": 250, "minLength": 1}, "livemode": {"title": "Livemode", "type": "boolean"}, "webhook_message": {"title": "Webhook message", "type": "string", "minLength": 1}, "validated_message": {"title": "Validated message", "type": "string", "minLength": 1, "x-nullable": true}, "valid": {"title": "Valid", "type": "boolean", "x-nullable": true}, "processed": {"title": "Processed", "type": "boolean"}, "customer": {"title": "Customer", "type": "integer", "x-nullable": true}}}, "InvoiceItem": {"required": ["stripe_id", "amount", "period_start", "period_end", "line_type", "invoice"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "stripe_id": {"title": "Stripe id", "type": "string", "maxLength": 255, "minLength": 1}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "currency": {"title": "Currency", "type": "string", "maxLength": 10, "minLength": 1}, "period_start": {"title": "Period start", "type": "string", "format": "date-time"}, "period_end": {"title": "Period end", "type": "string", "format": "date-time"}, "proration": {"title": "Proration", "type": "boolean"}, "line_type": {"title": "Line type", "type": "string", "maxLength": 50, "minLength": 1}, "description": {"title": "Description", "type": "string", "maxLength": 200}, "plan": {"title": "Plan", "type": "string", "maxLength": 100}, "quantity": {"title": "Quantity", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "invoice": {"title": "Invoice", "type": "integer"}}}, "Invoice": {"required": ["stripe_id", "period_end", "period_start", "subtotal", "total", "date", "customer"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "items": {"type": "array", "items": {"$ref": "#/definitions/InvoiceItem"}, "readOnly": true}, "charges": {"type": "array", "items": {"$ref": "#/definitions/Charge"}, "readOnly": true}, "stripe_id": {"title": "Stripe id", "type": "string", "maxLength": 255, "minLength": 1}, "attempted": {"title": "Attempted", "type": "boolean", "x-nullable": true}, "attempts": {"title": "Attempts", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true}, "closed": {"title": "Closed", "type": "boolean"}, "paid": {"title": "Paid", "type": "boolean"}, "period_end": {"title": "Period end", "type": "string", "format": "date-time"}, "period_start": {"title": "Period start", "type": "string", "format": "date-time"}, "subtotal": {"title": "Subtotal", "type": "string", "format": "decimal"}, "total": {"title": "Total", "type": "string", "format": "decimal"}, "currency": {"title": "Currency", "type": "string", "maxLength": 100, "minLength": 1}, "date": {"title": "Date", "type": "string", "format": "date-time"}, "charge": {"title": "Charge", "type": "string", "maxLength": 100}, "created_at": {"title": "Created at", "type": "string", "format": "date-time"}, "invoice_pdf": {"title": "Invoice pdf", "type": "string", "maxLength": 255}, "customer": {"title": "Customer", "type": "integer"}}}, "PhishingForwardedNotificationEmailToIMAPCredentialsMapping": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "readOnly": true}, "email": {"title": "Email", "type": "string", "readOnly": true, "minLength": 1}, "decrypted_password": {"title": "Decrypted password", "type": "string", "readOnly": true}}}, "PublicEmployeeTraining": {"required": ["employee_name", "employee_email", "training_name", "date_assigned"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "employee_name": {"title": "Employee name", "type": "string", "minLength": 1}, "employee_email": {"title": "Employee email", "type": "string", "minLength": 1}, "employee_id": {"title": "Employee id", "type": "string", "readOnly": true}, "training_name": {"title": "Training name", "type": "string", "minLength": 1}, "training_id": {"title": "Training id", "type": "string", "readOnly": true}, "date_assigned": {"title": "Date assigned", "type": "string", "format": "date-time"}, "completion_status": {"title": "Completion status", "type": "string", "readOnly": true}, "completion_rate": {"title": "Completion rate", "type": "string", "readOnly": true}, "completion_position": {"title": "Completion position", "type": "string", "readOnly": true}, "year": {"title": "Year", "type": "integer", "maximum": 32767, "minimum": 0}}}, "PublicEmployeeList": {"required": ["name", "email"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}}}, "PublicEmployee": {"required": ["name", "email"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "Employee name", "type": "string", "maxLength": 80, "minLength": 1}, "email": {"title": "Email", "type": "string", "format": "email", "maxLength": 254, "minLength": 1}}}, "PublicTraining": {"required": ["title", "employees_assigned", "employees_completed", "employees_not_completed", "training_completion_percentage", "number_of_lessons", "training_renews"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "title": {"title": "Title", "type": "string", "minLength": 1}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "employees_assigned": {"title": "Employees assigned", "type": "integer"}, "employees_completed": {"title": "Employees completed", "type": "integer"}, "employees_not_completed": {"title": "Employees not completed", "type": "integer"}, "training_completion_percentage": {"title": "Training completion percentage", "type": "integer"}, "number_of_lessons": {"title": "Number of lessons", "type": "integer"}, "training_renews": {"title": "Training renews", "type": "boolean"}}}, "PublicTrainingAssign": {"required": ["training_id", "employee_ids"], "type": "object", "properties": {"training_id": {"title": "Training id", "type": "string", "format": "uuid"}, "employee_ids": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1}, "alert_employees": {"title": "Alert employees", "type": "boolean", "default": true}}}, "question_quiz_question_serializer": {"required": ["quiz"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "quiz_question_context": {"title": "Quiz Question Context", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}, "answer_type": {"title": "Answer type", "type": "string", "enum": ["no_action", "user_acknowledged", "multiple_choice", "neutral", "written_response", "external_url"], "x-nullable": true}, "external_url": {"title": "External URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "external_url_btn_text": {"title": "External URL button text", "type": "string", "x-nullable": true}, "single_select": {"title": "Single select", "type": "boolean"}, "quiz": {"title": "Quiz", "type": "string", "format": "uuid"}, "editor_content": {"title": "Editor Content", "type": "string", "format": "uuid", "x-nullable": true}}}, "question_editor_state_serializer": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "note_editor_state": {"title": "Stringified note Editor's content", "type": "string", "x-nullable": true}, "summary_editor_state": {"title": "Stringified summary Editor's content", "type": "string", "x-nullable": true}, "question_editor_state": {"title": "Stringified question Editor's content", "type": "string", "x-nullable": true}, "quiz_editor_state": {"title": "Stringified quiz Editor's content", "type": "string", "x-nullable": true}, "quiz_message_state": {"title": "Stringified quiz message Editor's content", "type": "string", "x-nullable": true}, "content": {"type": "array", "items": {"type": "string", "format": "uuid"}, "readOnly": true, "uniqueItems": true}}}, "QuizQuestionWrite": {"required": ["quiz"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/QuizQuestionAnswer"}}, "editor_content": {"$ref": "#/definitions/question_editor_state_serializer"}, "image_ids": {"type": "array", "items": {"type": "string", "x-nullable": true}}, "custom_video_id": {"title": "Custom video id", "type": "string", "minLength": 1}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "position": {"title": "Position order", "type": "integer", "maximum": 32767, "minimum": -32768}, "quiz_question_context": {"title": "Quiz Question Context", "description": "You must use the Slack nomenclature for the markdown,\n        for more info visit: https://api.slack.com/reference/surfaces/formatting", "type": "string", "x-nullable": true}, "answer_type": {"title": "Answer type", "type": "string", "enum": ["no_action", "user_acknowledged", "multiple_choice", "neutral", "written_response", "external_url"], "x-nullable": true}, "external_url": {"title": "External URL", "type": "string", "format": "uri", "maxLength": 200, "x-nullable": true}, "external_url_btn_text": {"title": "External URL button text", "type": "string", "x-nullable": true}, "single_select": {"title": "Single select", "type": "boolean"}, "quiz": {"title": "Quiz", "type": "string", "format": "uuid"}}}, "WeeklyQuizWrite": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "title": {"title": "Title", "type": "string", "maxLength": 200, "x-nullable": true}, "is_technical": {"title": "Is technical", "type": "boolean"}, "anonymize_user_results": {"title": "Anonymize user results", "type": "boolean"}, "engagement_type": {"title": "Engagement Type", "type": "string", "enum": ["private", "channel"]}, "mention_channel": {"title": "Mention channel", "type": "boolean"}, "channel": {"title": "Channel", "type": "string", "maxLength": 20, "minLength": 1, "x-nullable": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}}}, "CompanyWeeklyQuizWrite": {"required": ["quiz", "company", "owners", "welcome_message", "closing_message"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "quiz": {"title": "Quiz", "type": "string", "format": "uuid"}, "company": {"title": "Company", "type": "string", "format": "uuid"}, "created_by": {"title": "Created by", "type": "string", "format": "uuid", "x-nullable": true}, "active": {"title": "Active", "type": "boolean"}, "start_date": {"title": "Start date", "type": "string", "format": "date-time", "x-nullable": true}, "channels": {"type": "array", "items": {"title": "Channels", "type": "string", "maxLength": 100, "minLength": 1}}, "okta_groups_sync": {"type": "array", "items": {"title": "Okta groups sync", "type": "string", "maxLength": 200, "minLength": 1}}, "auto_enroll": {"title": "Auto enroll", "type": "boolean"}, "send_cycle": {"title": "Send cycle", "type": "string", "enum": ["once", "weekly", "monthly", "quarterly", "semi-annual", "annual"]}, "respect_users_tz": {"title": "Respect users tz", "type": "boolean"}, "owners": {"type": "array", "items": {"type": "string", "format": "uuid"}, "uniqueItems": true}, "welcome_message": {"$ref": "#/definitions/RichTextEditorState"}, "welcome_message_markup": {"title": "Welcome message markup", "type": "string", "minLength": 1}, "welcome_message_enabled": {"title": "Welcome message enabled", "type": "boolean"}, "welcome_message_button_text": {"title": "Welcome message button text", "type": "string", "minLength": 1}, "closing_message": {"$ref": "#/definitions/RichTextEditorState"}, "closing_message_markup": {"title": "Closing message markup", "type": "string", "minLength": 1}, "closing_message_enabled": {"title": "Closing message enabled", "type": "boolean"}, "review_enabled": {"title": "Review enabled", "type": "boolean"}}}, "EngagementSchedules": {"required": ["send_time", "company_quiz"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "engagement_title": {"title": "Engagement title", "type": "string", "readOnly": true}, "created": {"title": "Created date", "type": "string", "format": "date-time", "readOnly": true}, "modified": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "send_time": {"title": "Send time", "type": "string", "format": "date-time"}, "is_sent": {"title": "Is sent", "type": "boolean"}, "company_quiz": {"title": "Company quiz", "type": "string", "format": "uuid"}}}, "Stream": {"required": ["title", "icon_url", "description"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "company": {"title": "Company", "type": "string", "format": "uuid", "x-nullable": true}, "title": {"title": "Title", "type": "string", "maxLength": 300, "minLength": 1}, "icon_url": {"title": "Icon URL", "type": "string", "maxLength": 300, "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}, "is_free": {"title": "Is Free Stream", "type": "boolean"}}}, "StreamPostWrite": {"required": ["title", "stream", "post_content", "editor_content", "stream_post_category"], "type": "object", "properties": {"title": {"title": "Title", "type": "string", "maxLength": 300, "minLength": 1}, "stream": {"title": "Parent Stream", "type": "string", "format": "uuid"}, "video_url": {"title": "Video ULR", "type": "string", "maxLength": 300, "x-nullable": true}, "post_content": {"title": "Post content", "type": "string", "minLength": 1}, "editor_content": {"$ref": "#/definitions/RichTextEditorState"}, "send_to_admins_only": {"title": "Send To Admins Only", "type": "boolean"}, "send_time": {"title": "Send time", "type": "string", "format": "date-time", "x-nullable": true}, "send_now": {"title": "Send Now", "type": "boolean"}, "is_sent": {"title": "Is Sent", "type": "boolean"}, "acknowledge_button": {"title": "Acknowledge Button", "type": "boolean"}, "include_rating": {"title": "Include Rating", "type": "boolean"}, "is_editable": {"title": "Is Editable (by Admins)", "type": "boolean"}, "stream_post_category": {"$ref": "#/definitions/StreamPostCategory"}}}}}