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.4-dev.856
1 structure change including:
1 Modification
Modified 1
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • enrolment property Added
0.0.4-dev.855
1 structure change including:
1 Modification
Modified 1
POST /v1/basket/{familyId}/checkout
  • Body
  • application/json content type Modified
    • paymentIntentId property Modified
      • Full types went from string to string | null
0.0.4-dev.854
1 structure change including:
1 Addition
Added 1
GET /v1/students/count
0.0.4-dev.853
1 structure change including:
1 Modification
Modified 1 Breaking
GET /v1/staff/{id}
  • Path went from /v1/staff/{staff} to /v1/staff/{id} (same operationId)
  • Path
  • staff path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • id path parameter Added
0.0.4-dev.851
4 structure changes including:
4 Modifications
Modified 4 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
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
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/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
0.0.4-dev.849
3 structure changes including:
2 Breaking changes
1 Addition
2 Removals
Removed 2 Breaking
GET /v1/company/teachers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/staff/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /v1/staff/{staff}
0.0.4-dev.847
1 structure change including:
1 Addition
Added 1
DELETE /v1/files/{entityId}/{purpose}
0.0.4-dev.846
6 structure changes including:
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
0.0.4-dev.845
1 structure change including:
1 Addition
Added 1
POST /v1/auth/link-family
0.0.4-dev.842
1 structure change including:
1 Addition
Added 1
POST /v1/demos/clear
0.0.4-dev.841
1 structure change including:
1 Addition
Added 1
GET /v1/trials/availability
0.0.4-dev.840
4 structure changes including:
4 Modifications
Modified 4 Breaking
PATCH /v1/users/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • LoginDto alternative Modified
        • user property Modified
      • UserDto alternative Modified
        • firstname, lastname properties Modified
          • Full types went from string to string | null
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • firstname, lastname properties Modified
          • Full types went from string to string | null
POST /v1/auth/register
  • Body
  • application/json content type Modified
    • firstname, lastname properties Modified
      • Full types went from string to string | null
      • Properties are no longer required
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, firstname, lastname, email, phone, email_verified_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • user, token properties Added
POST /v1/auth/reset-password
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • firstname, lastname properties Modified
          • Full types went from string to string | null
0.0.4-dev.838
8 structure changes including:
8 Modifications
Modified 8
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • company property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, tax, trial, billing, enrolment, integrations properties Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, trial, billing properties Modified
PATCH /v1/company/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, tax, trial, billing, enrolment, integrations properties Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, tax, trial, billing, enrolment, integrations properties Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, tax, trial, billing, enrolment, integrations properties Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • general, tax, trial, billing, enrolment, integrations properties Modified