diff --git a/openedx_events/learning/signals.py b/openedx_events/learning/signals.py index 5aa5f1c4..0165d3fa 100644 --- a/openedx_events/learning/signals.py +++ b/openedx_events/learning/signals.py @@ -8,14 +8,17 @@ docs/decisions/0003-events-payload.rst """ -from openedx_events.learning.data import ( - CertificateData, - CohortData, - CourseEnrollmentData, - UserData, -) +from openedx_events.learning.data import CertificateData, CohortData, CourseEnrollmentData, UserData from openedx_events.tooling import OpenEdxPublicSignal +# ..event_type: org.openedx.learning.student.registration.completed.v1 +# ..event_name: STUDENT_REGISTRATION_COMPLETED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user registration process in the LMS +# is completed. +# ..event_data: UserData +# ..event_creation_date: 2020-22-07 STUDENT_REGISTRATION_COMPLETED = OpenEdxPublicSignal( event_type="org.openedx.learning.student.registration.completed.v1", data={ @@ -24,6 +27,14 @@ ) +# ..event_type: org.openedx.learning.auth.session.login.completed.v1 +# ..event_name: SESSION_LOGIN_COMPLETED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's login process in the LMS is +# completed. +# ..event_data: UserData +# ..event_creation_date: 2020-22-07 SESSION_LOGIN_COMPLETED = OpenEdxPublicSignal( event_type="org.openedx.learning.auth.session.login.completed.v1", data={ @@ -32,6 +43,13 @@ ) +# ..event_type: org.openedx.learning.course.enrollment.created.v1 +# ..event_name: COURSE_ENROLLMENT_CREATED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's enrollment process is completed. +# ..event_data: CourseEnrollmentData +# ..event_creation_date: 2020-22-07 COURSE_ENROLLMENT_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.enrollment.created.v1", data={ @@ -40,6 +58,14 @@ ) +# ..event_type: org.openedx.learning.course.enrollment.changed.v1 +# ..event_name: COURSE_ENROLLMENT_CHANGED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's enrollment update process is +# completed. +# ..event_data: CourseEnrollmentData +# ..event_creation_date: 2020-22-07 COURSE_ENROLLMENT_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.course.enrollment.changed.v1", data={ @@ -48,14 +74,30 @@ ) +# ..event_type: org.openedx.learning.course.unenrollment.completed.v1 +# ..event_name: COURSE_ENROLLMENT_CHANGED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's unenrollment process is +# completed. +# ..event_data: CourseEnrollmentData +# ..event_creation_date: 2020-22-07 COURSE_UNENROLLMENT_COMPLETED = OpenEdxPublicSignal( - event_type="org.openedx.learning.course.enrollment.deactivated.v1", + event_type="org.openedx.learning.course.unenrollment.completed.v1", data={ "enrollment": CourseEnrollmentData, } ) +# ..event_type: org.openedx.learning.certificate.created.v1 +# ..event_name: CERTIFICATE_CREATED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's certificate creation process is +# completed. +# ..event_data: CertificateData +# ..event_creation_date: 2020-22-07 CERTIFICATE_CREATED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.created.v1", data={ @@ -64,6 +106,14 @@ ) +# ..event_type: org.openedx.learning.certificate.created.v1 +# ..event_name: CERTIFICATE_CREATED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's certificate creation process is +# completed. +# ..event_data: CertificateData +# ..event_creation_date: 2020-22-07 CERTIFICATE_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.changed.v1", data={ @@ -72,6 +122,14 @@ ) +# ..event_type: org.openedx.learning.certificate.revoked.v1 +# ..event_name: CERTIFICATE_REVOKED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's certificate annulation process +# is completed. +# ..event_data: CertificateData +# ..event_creation_date: 2020-22-07 CERTIFICATE_REVOKED = OpenEdxPublicSignal( event_type="org.openedx.learning.certificate.revoked.v1", data={ @@ -80,6 +138,13 @@ ) +# ..event_type: org.openedx.learning.cohort_membership.changed.v1 +# ..event_name: COHORT_MEMBERSHIP_CHANGED +# ..event_version: V1 +# ..event_implementation: OpenEdxPublicSignal(DjangoSignal) +# ..event_description: emitted when the user's cohort update is completed. +# ..event_data: CohortData +# ..event_creation_date: 2020-22-07 COHORT_MEMBERSHIP_CHANGED = OpenEdxPublicSignal( event_type="org.openedx.learning.cohort_membership.changed.v1", data={