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

Oct 22, 2024

stage
0.0.4-stage.10
Compare
0.0.4-stage.10

API structure has changed

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