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

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
GET /v1/transactions/
  • Query
  • where query parameter Modified
    • relatedTransactionId query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
1 structure change including:
1 Modification
Modified 1 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
1 structure change including:
1 Modification
Modified 1
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
1 structure change including:
1 Modification
Modified 1
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • Body
  • application/json content type Modified
    • description property Added
2 structure changes including:
2 Modifications
Modified 2
GET /v1/staff/
  • Query
  • sort query parameter Modified
    • lastname query parameter Added
GET /v1/trials/
  • Query
  • sort query parameter Modified
    • time query parameter Added
1 structure change including:
1 Modification
Modified 1 Breaking
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
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v1/transactions/create-custom
  • Body
  • application/json content type Modified
    • familyName property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
1 structure change including:
1 Addition
Added 1
POST /v1/auth/register/company
1 structure change including:
1 Modification
Modified 1
GET /v1/companies/
  • Query
  • sort query parameter Modified
    • createdAt query parameter Added
9 structure changes including:
9 Modifications
Modified 9
GET /v1/transactions/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • transaction property Modified
POST /v1/basket/{familyId}/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property 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/integrations/stripe/{familyId}/refunds/{transactionDetailId}
  • 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/transactions/create-custom
  • Body
  • application/json content type Modified
    • familyName property Added
  • 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-from-season
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added
POST /v1/transactions/create-manual-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • transaction property Modified
        • familyName property Added