Change Updates

Do not miss any Class Manager API changes, ever again

Subscribe to the Class Manager API changelog to be up to date on recent changes.

RSS
Class Manager

Changelog

Last update:
Compare
0.0.12-stage.0
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /v1/families/{id}/invite
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /v1/staff/{id}/invite
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
0.0.11-stage.0
10 structure changes including:
4 Additions
6 Modifications
Modified 6 Breaking
GET /v1/families/
  • Query
  • includeArchived query parameter Added
GET /v1/integrations/stripe/onboarding-link
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expiresAt property Modified
        • Type went from string(date-time) to string(date-time) | null
      • createdAt, type properties Added
GET /v1/integrations/stripe/profile-link
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expiresAt, type properties Added
GET /v1/students/
  • Query
  • includeArchived query parameter Added
GET /v1/transactions/
  • Query
  • sort query parameter Modified
    • date, createdAt query parameters Added
POST /v1/agreements/
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
Added 4
GET /v1/families/{id}/invite
GET /v1/families/{id}/user
GET /v1/staff/{id}/invite
GET /v1/staff/{id}/user
0.0.10-stage.0
1 structure change including:
1 Addition
Added 1
POST /v1/integrations/stripe/{familyId}/payment-intents/charge-payment-method
0.0.7-stage.0
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /v1/attendees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • trials property Modified
        • deletedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/trials/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • deletedAt property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/trials/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/trials/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/trials/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/trials/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/trials/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /v1/trials/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • deletedAt property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
0.0.4-stage.14
22 structure changes including:
5 Additions
17 Modifications
Modified 17
POST /v1/transactions/{transaction}/create-credit-note
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/transactions/create-manual-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/transactions/create-from-season
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/transactions/create-from-bill
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/transactions/create-custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/integrations/stripe/{familyId}/payment-intents/capture/{paymentIntentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/courses/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/courses/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/courses/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
POST /v1/basket/{familyId}/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
PATCH /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
GET /v1/transactions/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • aggregateId property Added
GET /v1/locations/
  • Query
  • includeArchived query parameter Added
GET /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • aggregateId property Added
GET /v1/courses/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • aggregateId property Added
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Added
Added 5
POST /v1/users/{user}/impersonate
POST /v1/payment-links/{paymentLinkId}/process
POST /v1/payment-links/{paymentLinkId}
GET /v1/users/
DELETE /v1/addresses/
0.0.4-stage.12
20 structure changes including:
1 Breaking change
1 Addition
18 Modifications
1 Removal
Modified 18
PUT /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/students/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/students/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/students/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/students/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/lesson-adjustments/change-lesson-date
  • Body
  • application/json content type Modified
    • oldTime property Added
POST /v1/lesson-adjustments/cancel-lesson
  • Body
  • application/json content type Modified
    • time property Added
POST /v1/integrations/stripe/{familyId}/payment-sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • ephemeralKey property Added
POST /v1/families/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/families/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/families/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
PATCH /v1/students/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
GET /v1/students/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
GET /v1/students/birthdays
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
GET /v1/students/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • createdAt property Added
GET /v1/families/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
GET /v1/families/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • createdAt property Added
Removed 1 Breaking
POST /v1/transactions/create-credit-note
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /v1/transactions/{transaction}/create-credit-note
0.0.4-stage.11
13 structure changes including:
13 Modifications
Modified 13 Breaking
GET /v1/attendees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • adjustments property Modified
        • startAt, endAt properties Modified
          • Properties are now required
            Breaking
        • studentId property Added
GET /v1/rooms/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
GET /v1/staff/
  • Query
  • sort query parameter Modified
    • lastname query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • createdAt property Added
GET /v1/staff/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • StaffDto alternative Modified
        • createdAt property Added
GET /v1/transactions/
  • Query
  • where query parameter Modified
    • relatedTransactionId query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
GET /v1/trials/
  • Query
  • sort query parameter Modified
    • time query parameter Added
POST /v1/auth/register/company
  • Body
  • application/json content type Modified
    • firstname, lastname, email, password properties Modified
      • Properties are no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Body
  • application/json content type Modified
    • description property Added
POST /v1/staff/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/staff/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/staff/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
POST /v1/staff/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
PUT /v1/staff/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • createdAt property Added
0.0.4-stage.10
24 structure changes including:
1 Breaking change
1 Addition
23 Modifications
Modified 23 Breaking
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • createdAt property Added
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • createdAt property Added
POST /v1/transactions/create-manual-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/transactions/create-from-season
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/transactions/create-from-bill
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/transactions/create-custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/transactions/create-credit-note
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • transaction, details, stats properties Added
POST /v1/integrations/stripe/{familyId}/payment-intents/capture/{paymentIntentId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/files/
  • Body
  • application/json content type Modified
    • entity_id property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • entityId property Added
POST /v1/basket/{familyId}/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/auth/reset-password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • email_verified_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • emailVerifiedAt property Added
POST /v1/auth/register
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • email_verified_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • emailVerifiedAt property Added
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • email_verified_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • emailVerifiedAt property Added
POST /v1/attendances/
  • Body
  • application/json content type Modified
    • status property Modified
      • Type went from string | null to string
        Breaking
PATCH /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • LoginDto alternative Modified
        • user property Modified
      • UserDto alternative Modified
        • email_verified_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • emailVerifiedAt property Added
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • createdAt property Added
PATCH /v1/company/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • createdAt property Added
GET /v1/transactions/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • transaction property Modified
GET /v1/lessons/{fromDate}/{toDate}
  • Path went from /v1/lessons/{date} to /v1/lessons/{fromDate}/{toDate} (same operationId)
    Breaking
  • Path
  • date path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • fromDate, toDate path parameters Added
  • Query
  • where query parameter Added
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_at property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • createdAt property Added
GET /v1/companies/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • createdAt property Added
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
Added 1
POST /v1/auth/register/company
0.0.4-stage.9
8 structure changes including:
1 Breaking change
1 Addition
7 Modifications
Modified 7 Breaking
DELETE /v1/files/for-entity/{entityId}/{purpose}
  • Path went from /v1/files/{entityId}/{purpose} to /v1/files/for-entity/{entityId}/{purpose} (same operationId)
    Breaking
GET /v1/attendances/stats
  • Query
  • lessons query parameter Modified
    • Query parameter is no longer required
  • courseId query parameter Added
GET /v1/courses/
  • Query
  • sort query parameter Modified
    • dayOfWeek query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • page, pageSize, selectAll query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/families/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
GET /v1/staff/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
GET /v1/students/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
POST /v1/attendances/
  • Body
  • application/json content type Modified
    • AttendanceStatus property Modified
      • Type went from string to string | null
Added 1
GET /v1/integrations/stripe/account
0.0.4-stage.7
8 structure changes including:
2 Additions
6 Modifications
Modified 6
GET /v1/courses/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • id property Added
PATCH /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • id property Added
POST /v1/courses/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • id property Added
POST /v1/courses/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • id property Added
POST /v1/courses/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • id property Added
Added 2
GET /v1/attendances/stats
GET /v1/lessons/{date}
0.0.4-stage.6
18 structure changes including:
2 Breaking changes
9 Additions
7 Modifications
2 Removals
Modified 7 Breaking
POST /v1/basket/{familyId}/checkout
  • Body
  • application/json content type Modified
    • paymentIntentId property Modified
      • Full types went from string to string | null
POST /v1/auth/reset-password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
POST /v1/auth/register
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
PATCH /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • LoginDto alternative Modified
        • user property Modified
      • UserDto alternative Modified
        • id, firstname, lastname, email, phone, email_verified_at properties Modified
          • Properties are now required
            Breaking
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Added
GET /v1/activity-logs/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • createdAt property Added
Removed 2 Breaking
GET /v1/staff/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/company/teachers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 9
POST /v1/transactions/create-credit-note
GET /v1/transactions/chart/by-charge-and-payment
GET /v1/students/count
GET /v1/students/birthdays
GET /v1/staff/{id}
GET /v1/families/count
GET /v1/enrolments/students/count
GET /v1/enrolments/chart/by-month
DELETE /v1/files/{entityId}/{purpose}
0.0.4-stage.5
7 structure changes including:
1 Addition
6 Modifications
Modified 6
GET /v1/waivers/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • type property Added
GET /v1/waivers/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
PATCH /v1/waivers/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
POST /v1/waivers/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
POST /v1/waivers/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
POST /v1/waivers/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
Added 1
POST /v1/auth/link-family