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

Sep 23, 2024

stage
0.0.4-stage.2
Compare
0.0.4-stage.2

API structure has changed

18 structure changes including:
1 Breaking change
3 Additions
15 Modifications
Modified 15 Breaking
PUT /v1/company/address
  • 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
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Body
  • application/json content type Modified
    • createCreditNote property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /v1/basket/{familyId}/checkout
  • Body
  • application/json content type Modified
    • items property Modified
      • Full types went from array[object] to object
        Breaking
      • enrolments, trials 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
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/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
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
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
PATCH /v1/company/settings
  • 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
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/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/auth/permissions
  • Path went from /auth/permissions to /v1/auth/permissions (same operationId)
    Breaking
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • company property Modified
Added 3
POST /v1/demos/clear
GET /v1/trials/availability
GET /v1/activity-logs/