Driftwatch

APIs / Box

Box API changes

Breaking changes, deprecations and new fields in the Box API, as they ship.

Box · a4f3e23d1 behavioral6 additive
5 new response fields
  • File.shared_link.one_time_passcode
  • File--Full.shared_link.one_time_passcode
  • WebLink.shared_link.one_time_passcode
  • Folder.shared_link.one_time_passcode
  • Folder--Full.shared_link.one_time_passcode
Box · 38fa64be1 breaking2 behavioral2 additive
Box · 1056514a1 breaking
  • Breakingdirection flip: their tools call this safe

    event_type can now return "SHIELD_PREVIEW_BLOCKED"

    Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.

    Event.event_type · reachable from 1 operation
    Code that breaks
    switch (response.event_type) {
      // existing branches …
      // no branch for "SHIELD_PREVIEW_BLOCKED"
      default:
        throw new Error("unexpected event_type");
    }
Box · f28eec5d8 additive
8 new response fields
  • File--Full.allowed_shared_link_access_levels
  • File--Full.authenticated_download_url
  • File--Full.is_download_available
  • File--Full.collections
  • File--Full.download_url
  • WebLink.allowed_shared_link_access_levels
  • WebLink.collections
  • Folder--Full.collections
Box · c9a878a97 additive
5 new response fields
  • SignRequest.request_flow
  • SignRequest--Base.request_flow
  • SignRequestSignerInput.is_validated
  • SignRequestSignerInput.reason
  • SignTemplate.request_flow
2 new request properties
  • SignRequest--Base.request_flow
  • SignRequestCreateRequest.request_flow
Box · 8b694ffa1 breaking
Box · 155f09b51 additive
  • Additive

    Response field error_code added

    No action needed unless you validate responses against a closed schema.

    SignRequest.error_code · reachable from 4 operations
Box · fdb6596c1 breaking
  • Breakingdirection flip: their tools call this safe

    status can now return "error"

    Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.

    SignRequest.status · reachable from 4 operations
    Code that breaks
    switch (response.status) {
      // existing branches …
      // no branch for "error"
      default:
        throw new Error("unexpected status");
    }
Box · f5fd73261 breaking
Box · bcd4afb85 additive
4 new response fields
  • MetadataTemplate.fields[].namespace
  • MetadataTemplate.fields[].optionsRules
  • MetadataTemplate.fields[].taxonomyId
  • MetadataTemplate.fields[].taxonomyKey