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

Nov 26, 2024

prod
0.0.10
Compare
0.0.10

API structure has changed

299 structure changes including:
2 Breaking changes
287 Additions
11 Modifications
1 Removal
Modified 11 Breaking
DELETE /v1/staff/{id}
  • Response
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 404 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
PUT /v1/staff/{id}
  • Body
  • application/json content type Modified
    • firstname, lastname properties Modified
      • Properties are no longer required
    • permission_set, job_title properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • StaffPermissionSet, jobTitle, joinedAt properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email, phone properties Modified
        • Properties are now required
          Breaking
      • company_id, permission_set, job_title, verification_status properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • companyId, AccountPermissionSet, jobTitle, invitationStatus, archivedAt, deletedAt, joinedAt, createdAt, profilePicture properties Added
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 404 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
POST /v1/staff/{id}/invite
  • Response
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 404, 204 responses Added
  • Body
  • application/json content type Added
POST /v1/staff/
  • Body
  • application/json content type Modified
    • permission_set, job_title properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • sendInvite, StaffPermissionSet, jobTitle, joinedAt properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email, phone properties Modified
        • Properties are now required
          Breaking
      • company_id, permission_set, job_title, verification_status properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • companyId, AccountPermissionSet, jobTitle, invitationStatus, archivedAt, deletedAt, joinedAt, createdAt, profilePicture properties Added
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 422 response Added
POST /v1/auth/register
  • Body
  • application/json content type Modified
    • link_ref property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • firstname, lastname properties Added
  • 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/logout
  • Response
  • 401 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • id, phone properties Modified
          • Properties are now required
            Breaking
        • firstname, lastname properties Modified
          • Properties are now required
            Breaking
          • Type went from string to string | null
        • email property Modified
          • Property is now required
            Breaking
          • Type went from object to string
            Breaking
        • email_verified_at property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • emailVerifiedAt property Added
  • 422 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
POST /v1/auth/check-existence
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
GET /v1/staff/
  • Query
  • page, pageSize query parameters Modified
    • Type went from string to number
      Breaking
  • selectAll query parameter Modified
    • Type went from string to boolean
      Breaking
  • where query parameter Modified
    • created_at, firstname, lastname query parameters Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • id query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • permissionSet query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • invitationStatus query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
  • sort query parameter Modified
    • * query parameter Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • firstname, lastname, createdAt query parameters Added
  • onlyArchived query parameter Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • email, phone properties Modified
          • Properties are now required
            Breaking
        • company_id, permission_set, job_title, verification_status properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • companyId, AccountPermissionSet, jobTitle, invitationStatus, archivedAt, deletedAt, joinedAt, createdAt, profilePicture properties Added
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
GET /v1/links/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data, pagination properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id, type, companyId, entityId, email, firstname, lastname, expiresAt properties Added
  • 404 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
GET /v1/auth/accounts
  • Path went from /v1/accounts to /v1/auth/accounts (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
          • Type went from object to object | null
        • entityId, permissionSet properties Added
      • pagination property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 403 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • statusCode, messages properties Added
Removed 1 Breaking
GET /v1/staff/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 287
POST /v1/messages/send
POST /v1/integrations/stripe/{familyId}/payment-sessions
POST /v1/integrations/stripe/{familyId}/payment-methods/{paymentMethodId}/set-default
POST /v1/integrations/stripe/{familyId}/payment-intents/charge-payment-method
POST /v1/integrations/stripe/{familyId}/payment-intents/capture/{paymentIntentId}
POST /v1/integrations/quickbooks/sync-all
POST /v1/integrations/quickbooks/disconnect
POST /v1/integrations/quickbooks/
POST /v1/holidays/{id}/restore
POST /v1/holidays/restore
POST /v1/holidays/
POST /v1/files/direct-upload-link
POST /v1/files/
POST /v1/families/{id}/unarchive
POST /v1/families/{id}/restore
POST /v1/families/{id}/invite-cancel
POST /v1/families/{id}/invite
POST /v1/families/{id}/archive
POST /v1/messages/
POST /v1/locations/{id}/unarchive
POST /v1/locations/{id}/restore
POST /v1/locations/{id}/archive
POST /v1/locations/unarchive
POST /v1/locations/restore
POST /v1/locations/archive
POST /v1/locations/
POST /v1/links/{id}/process
POST /v1/lesson-adjustments/{id}/restore
POST /v1/lesson-adjustments/restore
POST /v1/lesson-adjustments/change-lesson-date
POST /v1/lesson-adjustments/cancel-lesson
POST /v1/lesson-adjustments/cancel-class
POST /v1/lesson-adjustments/additional-lesson
POST /v1/integrations/stripe/{familyId}/setup-intents
POST /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
POST /v1/discount-scheme-values/{id}/restore
POST /v1/discount-scheme-values/restore
POST /v1/discount-scheme-values/
POST /v1/demos/clear
POST /v1/custom-fields/
POST /v1/courses/{id}/unarchive
POST /v1/courses/{id}/restore
POST /v1/courses/{id}/archive
POST /v1/courses/unarchive
POST /v1/courses/restore
POST /v1/courses/archive
POST /v1/courses/
POST /v1/contacts/{id}/restore
POST /v1/contacts/{id}/mark-as-primary
POST /v1/contacts/restore
POST /v1/contacts/
GET /v1/attendances/{id}
POST /v1/families/unarchive
POST /v1/families/restore
POST /v1/families/archive
POST /v1/families/
POST /v1/enrolments/{id}/restore
POST /v1/enrolments/restore
POST /v1/enrolments/
POST /v1/enrolment-adjustments/{id}/restore
POST /v1/enrolment-adjustments/restore
POST /v1/enrolment-adjustments/make-up-lesson
POST /v1/enrolment-adjustments/extra-lesson
POST /v1/enrolment-adjustments/delayed-start-enrolment
POST /v1/enrolment-adjustments/cancel-enrolment
POST /v1/discount-schemes/{id}/status
POST /v1/discount-schemes/{id}/restore
POST /v1/discount-schemes/restore
POST /v1/discount-schemes/
PUT /v1/trials/{id}
POST /v1/waiting-lists/{id}/restore
POST /v1/waiting-lists/restore
POST /v1/waiting-lists/
POST /v1/users/{user}/impersonate
POST /v1/trials/{id}/unarchive
POST /v1/trials/{id}/restore
POST /v1/trials/{id}/archive
POST /v1/trials/unarchive
POST /v1/trials/restore
POST /v1/trials/archive
POST /v1/trials/
POST /v1/transactions/{transaction}/create-credit-note
POST /v1/transactions/create-manual-payment
POST /v1/transactions/create-from-season
POST /v1/transactions/create-from-bill
POST /v1/transactions/create-custom
POST /v1/tax-rates/{id}/make-default
PUT /v1/tax-rates/{id}
PUT /v1/rooms/{id}
PUT /v1/pricing-scheme-values/{id}
PUT /v1/locations/{id}
PUT /v1/holidays/{id}
PUT /v1/families/{id}
PUT /v1/discount-scheme-values/{id}
PUT /v1/custom-fields/{id}
PUT /v1/contacts/{id}
PUT /v1/company/address
PUT /v1/company
PUT /v1/addresses/
POST /v1/waivers/{id}/unarchive
POST /v1/waivers/{id}/archive
POST /v1/waivers/unarchive
POST /v1/waivers/archive
POST /v1/waivers/
POST /v1/seasons/{id}/archive
POST /v1/seasons/unarchive
POST /v1/seasons/restore
POST /v1/seasons/archive
POST /v1/seasons/
POST /v1/rooms/{id}/unarchive
POST /v1/rooms/{id}/restore
POST /v1/rooms/{id}/archive
POST /v1/rooms/unarchive
POST /v1/rooms/restore
POST /v1/rooms/archive
POST /v1/rooms/
POST /v1/pricing-scheme-values/{id}/restore
POST /v1/pricing-scheme-values/restore
POST /v1/pricing-scheme-values/
POST /v1/payment-links/{paymentLinkId}/process
POST /v1/payment-links/{paymentLinkId}
POST /v1/tax-rates/
POST /v1/students/{id}/unarchive
POST /v1/students/{id}/restore
POST /v1/students/{id}/archive
POST /v1/students/unarchive
POST /v1/students/restore
POST /v1/students/archive
POST /v1/students/
POST /v1/staff/{id}/unarchive
POST /v1/staff/{id}/restore
POST /v1/staff/{id}/invite-cancel
POST /v1/staff/{id}/archive
POST /v1/staff/unarchive
POST /v1/staff/restore
POST /v1/staff/archive
POST /v1/seasons/{id}/unarchive
POST /v1/seasons/{id}/restore
GET /v1/attendances/stats
GET /v1/attendances/
GET /v1/agreements/
GET /v1/addresses/
GET /v1/activity-logs/
DELETE /v1/waivers/{id}
DELETE /v1/waiting-lists/{id}
DELETE /v1/waiting-lists/
DELETE /v1/trials/{id}
DELETE /v1/trials/
DELETE /v1/transactions/{id}
DELETE /v1/tax-rates/{id}
DELETE /v1/students/{id}
DELETE /v1/students/
DELETE /v1/staff/
DELETE /v1/seasons/{id}
DELETE /v1/seasons/
DELETE /v1/enrolments/
GET /v1/discount-schemes/
GET /v1/discount-scheme-values/{id}
GET /v1/discount-scheme-values/
GET /v1/custom-fields/{id}
GET /v1/custom-fields/
GET /v1/custom-field-responses/
GET /v1/courses/{id}
GET /v1/courses/
GET /v1/contacts/{id}
GET /v1/contacts/receives-additional
GET /v1/contacts/
GET /v1/company/{slug}
GET /v1/company/{id}
GET /v1/companies/
GET /v1/billing/{familyId}
GET /v1/basket/{familyId}/quote
GET /v1/balances
GET /v1/auth/permissions
GET /v1/attendees
DELETE /v1/enrolment-adjustments/{id}
DELETE /v1/enrolment-adjustments/
DELETE /v1/discount-schemes/{id}
DELETE /v1/discount-schemes/
DELETE /v1/discount-scheme-values/{id}
DELETE /v1/discount-scheme-values/
DELETE /v1/custom-fields/{id}
DELETE /v1/courses/{id}
DELETE /v1/courses/
DELETE /v1/contacts/{id}
DELETE /v1/contacts/
DELETE /v1/company/address
DELETE /v1/companies/{id}
DELETE /v1/avatars
DELETE /v1/auth/accounts/revoke
DELETE /v1/attendances/{id}
DELETE /v1/attendances/
DELETE /v1/addresses/
DELETE /v1/rooms/{id}
DELETE /v1/rooms/
DELETE /v1/pricing-scheme-values/{id}
DELETE /v1/pricing-scheme-values/
DELETE /v1/messages/{id}
DELETE /v1/messages/
DELETE /v1/locations/{id}
DELETE /v1/locations/
DELETE /v1/lesson-adjustments/{id}
DELETE /v1/lesson-adjustments/
DELETE /v1/integrations/stripe/{familyId}/payment-methods/{paymentMethodId}
DELETE /v1/integrations/quickbooks/reset
DELETE /v1/holidays/{id}
DELETE /v1/holidays/
DELETE /v1/files/{id}
DELETE /v1/files/for-entity/{entityId}/{purpose}
DELETE /v1/families/{id}
DELETE /v1/families/
DELETE /v1/enrolments/{id}
PATCH /v1/company/settings
GET /v1/waivers/{id}
GET /v1/waivers/
GET /v1/waiting-lists/
GET /v1/users/
GET /v1/trials/{id}
GET /v1/trials/availability
GET /v1/trials/
GET /v1/transactions/chart/by-charge-and-payment
GET /v1/transactions/
GET /v1/tax-rates/{id}
GET /v1/tax-rates/
GET /v1/students/{id}
GET /v1/students/count
GET /v1/students/birthdays
GET /v1/students/
GET /v1/staff/{id}
GET /v1/seasons/{id}
GET /v1/integrations/stripe/onboarding-link
POST /v1/basket/{familyId}/checkout
POST /v1/avatars
POST /v1/auth/reset-password
POST /v1/auth/register/company
POST /v1/auth/link-family
POST /v1/auth/forgot-password
POST /v1/auth/check-token
POST /v1/attendances/{id}/restore
POST /v1/attendances/restore
POST /v1/attendances/
POST /v1/agreements/
PATCH /v1/waivers/{id}
PATCH /v1/users/
PATCH /v1/students/{id}
PATCH /v1/seasons/{id}
PATCH /v1/features/
PATCH /v1/custom-field-responses/
PATCH /v1/courses/{id}
PATCH /v1/company/settings/look-and-feel
GET /v1/integrations/stripe/account
GET /v1/integrations/quickbooks/sign-in-url
GET /v1/integrations/quickbooks/
GET /v1/holidays/{id}
GET /v1/holidays/
GET /v1/files/{id}
GET /v1/features/
GET /v1/families/{id}
GET /v1/families/{familyId}/balance
GET /v1/families/count
GET /v1/families/
GET /v1/enrolments/{id}
GET /v1/enrolments/students/count
GET /v1/enrolments/chart/by-month
GET /v1/enrolments/
GET /v1/enrolment-adjustments/{id}
GET /v1/enrolment-adjustments/
GET /v1/discount-schemes/{id}
GET /v1/seasons/
GET /v1/search/key
GET /v1/rooms/{id}
GET /v1/rooms/
GET /v1/pricing-scheme-values/{id}
GET /v1/pricing-scheme-values/
GET /v1/messages/{id}
GET /v1/messages/
GET /v1/message-instances/{messageId}
GET /v1/locations/{id}
GET /v1/locations/
GET /v1/lessons/{fromDate}/{toDate}
GET /v1/lessons
GET /v1/lesson-adjustments/{id}
GET /v1/lesson-adjustments/
GET /v1/integrations/stripe/{family}/payment-methods
GET /v1/integrations/stripe/{familyId}/refunds/{transactionDetailId}
GET /v1/integrations/stripe/{familyId}/payment-intents/{transactionDetail}
GET /v1/integrations/stripe/profile-link