box-node-sdk 10.0.1 → 10.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +105 -69
- package/lib/box/errors.d.ts.map +1 -1
- package/lib/box/errors.js +2 -0
- package/lib/box/errors.js.map +1 -1
- package/lib/bundle.js +1725 -25
- package/lib/bundle.js.map +1 -1
- package/lib/client.d.ts +3 -1
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +5 -0
- package/lib/client.js.map +1 -1
- package/lib/managers/archives.d.ts +60 -1
- package/lib/managers/archives.d.ts.map +1 -1
- package/lib/managers/archives.js +120 -3
- package/lib/managers/archives.js.map +1 -1
- package/lib/managers/enterpriseConfigurations.d.ts +60 -0
- package/lib/managers/enterpriseConfigurations.d.ts.map +1 -0
- package/lib/managers/enterpriseConfigurations.js +95 -0
- package/lib/managers/enterpriseConfigurations.js.map +1 -0
- package/lib/managers/index.d.ts +1 -0
- package/lib/managers/index.d.ts.map +1 -1
- package/lib/managers/index.js +1 -0
- package/lib/managers/index.js.map +1 -1
- package/lib/managers/users.d.ts +5 -5
- package/lib/managers/users.d.ts.map +1 -1
- package/lib/managers/users.js +3 -3
- package/lib/networking/boxNetworkClient.d.ts.map +1 -1
- package/lib/networking/boxNetworkClient.js +10 -4
- package/lib/networking/boxNetworkClient.js.map +1 -1
- package/lib/networking/retries.d.ts.map +1 -1
- package/lib/networking/retries.js +3 -1
- package/lib/networking/retries.js.map +1 -1
- package/lib/networking/version.d.ts +1 -1
- package/lib/networking/version.js +1 -1
- package/lib/schemas/v2025R0/archiveV2025R0.d.ts +25 -2
- package/lib/schemas/v2025R0/archiveV2025R0.d.ts.map +1 -1
- package/lib/schemas/v2025R0/archiveV2025R0.js +72 -1
- package/lib/schemas/v2025R0/archiveV2025R0.js.map +1 -1
- package/lib/schemas/v2025R0/collaborationPermissionsV2025R0.d.ts +28 -0
- package/lib/schemas/v2025R0/collaborationPermissionsV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/collaborationPermissionsV2025R0.js +94 -0
- package/lib/schemas/v2025R0/collaborationPermissionsV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/customSessionDurationGroupItemV2025R0.d.ts +13 -0
- package/lib/schemas/v2025R0/customSessionDurationGroupItemV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/customSessionDurationGroupItemV2025R0.js +31 -0
- package/lib/schemas/v2025R0/customSessionDurationGroupItemV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.d.ts +96 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.js +640 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.d.ts +10 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.js +41 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.d.ts +10 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.js +42 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.d.ts +10 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.js +42 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemV2025R0.d.ts +10 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemV2025R0.js +25 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationItemV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.d.ts +83 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.js +472 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.d.ts +11 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.js +41 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.d.ts +37 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.js +224 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationV2025R0.d.ts +24 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationV2025R0.js +101 -0
- package/lib/schemas/v2025R0/enterpriseConfigurationV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingV2025R0.d.ts +37 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingV2025R0.js +119 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.d.ts +9 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.js +44 -0
- package/lib/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.d.ts +32 -0
- package/lib/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.js +151 -0
- package/lib/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/hubItemReferenceV2025R0.js +2 -2
- package/lib/schemas/v2025R0/hubItemReferenceV2025R0.js.map +1 -1
- package/lib/schemas/v2025R0/index.d.ts +20 -0
- package/lib/schemas/v2025R0/index.d.ts.map +1 -1
- package/lib/schemas/v2025R0/index.js +20 -0
- package/lib/schemas/v2025R0/index.js.map +1 -1
- package/lib/schemas/v2025R0/keysafeSettingsV2025R0.d.ts +28 -0
- package/lib/schemas/v2025R0/keysafeSettingsV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/keysafeSettingsV2025R0.js +78 -0
- package/lib/schemas/v2025R0/keysafeSettingsV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/listUserV2025R0.d.ts +16 -0
- package/lib/schemas/v2025R0/listUserV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/listUserV2025R0.js +36 -0
- package/lib/schemas/v2025R0/listUserV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/sharedLinkPermissionsV2025R0.d.ts +19 -0
- package/lib/schemas/v2025R0/sharedLinkPermissionsV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/sharedLinkPermissionsV2025R0.js +63 -0
- package/lib/schemas/v2025R0/sharedLinkPermissionsV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/shieldRuleItemV2025R0.d.ts +38 -0
- package/lib/schemas/v2025R0/shieldRuleItemV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/shieldRuleItemV2025R0.js +130 -0
- package/lib/schemas/v2025R0/shieldRuleItemV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/userOrGroupReferenceV2025R0.d.ts +16 -0
- package/lib/schemas/v2025R0/userOrGroupReferenceV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/userOrGroupReferenceV2025R0.js +49 -0
- package/lib/schemas/v2025R0/userOrGroupReferenceV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/userTrackingCodeV2025R0.d.ts +13 -0
- package/lib/schemas/v2025R0/userTrackingCodeV2025R0.d.ts.map +1 -0
- package/lib/schemas/v2025R0/userTrackingCodeV2025R0.js +32 -0
- package/lib/schemas/v2025R0/userTrackingCodeV2025R0.js.map +1 -0
- package/lib/schemas/v2025R0/weblinkReferenceV2025R0.d.ts +3 -3
- package/lib/schemas/v2025R0/weblinkReferenceV2025R0.d.ts.map +1 -1
- package/lib/schemas/v2025R0/weblinkReferenceV2025R0.js +3 -3
- package/lib/schemas/v2025R0/weblinkReferenceV2025R0.js.map +1 -1
- package/lib-esm/box/errors.js +2 -0
- package/lib-esm/box/errors.js.map +1 -1
- package/lib-esm/client.d.ts +3 -1
- package/lib-esm/client.js +6 -0
- package/lib-esm/client.js.map +1 -1
- package/lib-esm/managers/archives.d.ts +60 -1
- package/lib-esm/managers/archives.js +124 -3
- package/lib-esm/managers/archives.js.map +1 -1
- package/lib-esm/managers/enterpriseConfigurations.d.ts +59 -0
- package/lib-esm/managers/enterpriseConfigurations.js +91 -0
- package/lib-esm/managers/enterpriseConfigurations.js.map +1 -0
- package/lib-esm/managers/index.d.ts +1 -0
- package/lib-esm/managers/index.js +1 -0
- package/lib-esm/managers/index.js.map +1 -1
- package/lib-esm/managers/users.d.ts +5 -5
- package/lib-esm/managers/users.js +3 -3
- package/lib-esm/networking/boxNetworkClient.js +10 -4
- package/lib-esm/networking/boxNetworkClient.js.map +1 -1
- package/lib-esm/networking/retries.js +3 -1
- package/lib-esm/networking/retries.js.map +1 -1
- package/lib-esm/networking/version.d.ts +1 -1
- package/lib-esm/networking/version.js +1 -1
- package/lib-esm/schemas/v2025R0/archiveV2025R0.d.ts +25 -2
- package/lib-esm/schemas/v2025R0/archiveV2025R0.js +78 -1
- package/lib-esm/schemas/v2025R0/archiveV2025R0.js.map +1 -1
- package/lib-esm/schemas/v2025R0/collaborationPermissionsV2025R0.d.ts +27 -0
- package/lib-esm/schemas/v2025R0/collaborationPermissionsV2025R0.js +94 -0
- package/lib-esm/schemas/v2025R0/collaborationPermissionsV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/customSessionDurationGroupItemV2025R0.d.ts +12 -0
- package/lib-esm/schemas/v2025R0/customSessionDurationGroupItemV2025R0.js +31 -0
- package/lib-esm/schemas/v2025R0/customSessionDurationGroupItemV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.d.ts +95 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.js +655 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.d.ts +9 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.js +41 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.d.ts +9 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.js +42 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.d.ts +9 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.js +42 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemV2025R0.d.ts +9 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemV2025R0.js +25 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationItemV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.d.ts +82 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.js +487 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.d.ts +10 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.js +41 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.d.ts +36 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.js +227 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationV2025R0.d.ts +23 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationV2025R0.js +101 -0
- package/lib-esm/schemas/v2025R0/enterpriseConfigurationV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingV2025R0.d.ts +36 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingV2025R0.js +119 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.d.ts +8 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.js +47 -0
- package/lib-esm/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.d.ts +31 -0
- package/lib-esm/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.js +151 -0
- package/lib-esm/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/hubItemReferenceV2025R0.js +2 -2
- package/lib-esm/schemas/v2025R0/hubItemReferenceV2025R0.js.map +1 -1
- package/lib-esm/schemas/v2025R0/index.d.ts +20 -0
- package/lib-esm/schemas/v2025R0/index.js +20 -0
- package/lib-esm/schemas/v2025R0/index.js.map +1 -1
- package/lib-esm/schemas/v2025R0/keysafeSettingsV2025R0.d.ts +27 -0
- package/lib-esm/schemas/v2025R0/keysafeSettingsV2025R0.js +78 -0
- package/lib-esm/schemas/v2025R0/keysafeSettingsV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/listUserV2025R0.d.ts +15 -0
- package/lib-esm/schemas/v2025R0/listUserV2025R0.js +36 -0
- package/lib-esm/schemas/v2025R0/listUserV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/sharedLinkPermissionsV2025R0.d.ts +18 -0
- package/lib-esm/schemas/v2025R0/sharedLinkPermissionsV2025R0.js +63 -0
- package/lib-esm/schemas/v2025R0/sharedLinkPermissionsV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/shieldRuleItemV2025R0.d.ts +37 -0
- package/lib-esm/schemas/v2025R0/shieldRuleItemV2025R0.js +130 -0
- package/lib-esm/schemas/v2025R0/shieldRuleItemV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/userOrGroupReferenceV2025R0.d.ts +15 -0
- package/lib-esm/schemas/v2025R0/userOrGroupReferenceV2025R0.js +49 -0
- package/lib-esm/schemas/v2025R0/userOrGroupReferenceV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/userTrackingCodeV2025R0.d.ts +12 -0
- package/lib-esm/schemas/v2025R0/userTrackingCodeV2025R0.js +32 -0
- package/lib-esm/schemas/v2025R0/userTrackingCodeV2025R0.js.map +1 -0
- package/lib-esm/schemas/v2025R0/weblinkReferenceV2025R0.d.ts +3 -3
- package/lib-esm/schemas/v2025R0/weblinkReferenceV2025R0.js +3 -3
- package/lib-esm/schemas/v2025R0/weblinkReferenceV2025R0.js.map +1 -1
- package/package.json +1 -1
- package/src/box/errors.ts +2 -0
- package/src/client.ts +7 -0
- package/src/managers/archives.ts +202 -2
- package/src/managers/enterpriseConfigurations.ts +180 -0
- package/src/managers/index.ts +1 -0
- package/src/managers/users.ts +5 -5
- package/src/networking/boxNetworkClient.ts +12 -5
- package/src/networking/retries.ts +3 -1
- package/src/networking/version.ts +1 -1
- package/src/schemas/v2025R0/archiveV2025R0.ts +106 -2
- package/src/schemas/v2025R0/collaborationPermissionsV2025R0.ts +150 -0
- package/src/schemas/v2025R0/customSessionDurationGroupItemV2025R0.ts +46 -0
- package/src/schemas/v2025R0/enterpriseConfigurationContentAndSharingV2025R0.ts +1190 -0
- package/src/schemas/v2025R0/enterpriseConfigurationItemBooleanV2025R0.ts +58 -0
- package/src/schemas/v2025R0/enterpriseConfigurationItemIntegerV2025R0.ts +58 -0
- package/src/schemas/v2025R0/enterpriseConfigurationItemStringV2025R0.ts +56 -0
- package/src/schemas/v2025R0/enterpriseConfigurationItemV2025R0.ts +37 -0
- package/src/schemas/v2025R0/enterpriseConfigurationSecurityV2025R0.ts +848 -0
- package/src/schemas/v2025R0/enterpriseConfigurationShieldV2025R0.ts +59 -0
- package/src/schemas/v2025R0/enterpriseConfigurationUserSettingsV2025R0.ts +434 -0
- package/src/schemas/v2025R0/enterpriseConfigurationV2025R0.ts +155 -0
- package/src/schemas/v2025R0/enterpriseFeatureSettingV2025R0.ts +178 -0
- package/src/schemas/v2025R0/enterpriseFeatureSettingsItemV2025R0.ts +62 -0
- package/src/schemas/v2025R0/externalCollabSecuritySettingsV2025R0.ts +208 -0
- package/src/schemas/v2025R0/hubItemReferenceV2025R0.ts +2 -2
- package/src/schemas/v2025R0/index.ts +20 -0
- package/src/schemas/v2025R0/keysafeSettingsV2025R0.ts +117 -0
- package/src/schemas/v2025R0/listUserV2025R0.ts +49 -0
- package/src/schemas/v2025R0/sharedLinkPermissionsV2025R0.ts +98 -0
- package/src/schemas/v2025R0/shieldRuleItemV2025R0.ts +188 -0
- package/src/schemas/v2025R0/userOrGroupReferenceV2025R0.ts +68 -0
- package/src/schemas/v2025R0/userTrackingCodeV2025R0.ts +44 -0
- package/src/schemas/v2025R0/weblinkReferenceV2025R0.ts +5 -5
- package/src/test/archives.test.ts +25 -0
- package/src/test/enterpriseConfigurations.test.ts +86 -0
- package/src/test/events.test.ts +1 -1
- package/lib-esm/test/ai.test.d.ts +0 -3
- package/lib-esm/test/ai.test.js +0 -428
- package/lib-esm/test/ai.test.js.map +0 -1
- package/lib-esm/test/aiStudio.test.d.ts +0 -3
- package/lib-esm/test/aiStudio.test.js +0 -102
- package/lib-esm/test/aiStudio.test.js.map +0 -1
- package/lib-esm/test/appItemAssociations.test.d.ts +0 -1
- package/lib-esm/test/appItemAssociations.test.js +0 -70
- package/lib-esm/test/appItemAssociations.test.js.map +0 -1
- package/lib-esm/test/archives.test.d.ts +0 -4
- package/lib-esm/test/archives.test.js +0 -32
- package/lib-esm/test/archives.test.js.map +0 -1
- package/lib-esm/test/auth.test.d.ts +0 -3
- package/lib-esm/test/auth.test.js +0 -382
- package/lib-esm/test/auth.test.js.map +0 -1
- package/lib-esm/test/avatars.test.d.ts +0 -3
- package/lib-esm/test/avatars.test.js +0 -36
- package/lib-esm/test/avatars.test.js.map +0 -1
- package/lib-esm/test/chunkedUploads.test.d.ts +0 -22
- package/lib-esm/test/chunkedUploads.test.js +0 -247
- package/lib-esm/test/chunkedUploads.test.js.map +0 -1
- package/lib-esm/test/classifications.test.d.ts +0 -3
- package/lib-esm/test/classifications.test.js +0 -52
- package/lib-esm/test/classifications.test.js.map +0 -1
- package/lib-esm/test/client.test.d.ts +0 -46
- package/lib-esm/test/client.test.js +0 -310
- package/lib-esm/test/client.test.js.map +0 -1
- package/lib-esm/test/collaborationAllowlistEntries.test.d.ts +0 -3
- package/lib-esm/test/collaborationAllowlistEntries.test.js +0 -43
- package/lib-esm/test/collaborationAllowlistEntries.test.js.map +0 -1
- package/lib-esm/test/collaborationAllowlistExemptTargets.test.d.ts +0 -3
- package/lib-esm/test/collaborationAllowlistExemptTargets.test.js +0 -43
- package/lib-esm/test/collaborationAllowlistExemptTargets.test.js.map +0 -1
- package/lib-esm/test/collections.test.d.ts +0 -3
- package/lib-esm/test/collections.test.js +0 -40
- package/lib-esm/test/collections.test.js.map +0 -1
- package/lib-esm/test/comments.test.d.ts +0 -3
- package/lib-esm/test/comments.test.js +0 -78
- package/lib-esm/test/comments.test.js.map +0 -1
- package/lib-esm/test/commons.d.ts +0 -21
- package/lib-esm/test/commons.js +0 -161
- package/lib-esm/test/commons.js.map +0 -1
- package/lib-esm/test/devicePinners.test.d.ts +0 -3
- package/lib-esm/test/devicePinners.test.js +0 -29
- package/lib-esm/test/devicePinners.test.js.map +0 -1
- package/lib-esm/test/docgen.test.d.ts +0 -3
- package/lib-esm/test/docgen.test.js +0 -135
- package/lib-esm/test/docgen.test.js.map +0 -1
- package/lib-esm/test/docgenTemplate.test.d.ts +0 -3
- package/lib-esm/test/docgenTemplate.test.js +0 -29
- package/lib-esm/test/docgenTemplate.test.js.map +0 -1
- package/lib-esm/test/downloads.test.d.ts +0 -3
- package/lib-esm/test/downloads.test.js +0 -96
- package/lib-esm/test/downloads.test.js.map +0 -1
- package/lib-esm/test/emailAliases.test.d.ts +0 -3
- package/lib-esm/test/emailAliases.test.js +0 -34
- package/lib-esm/test/emailAliases.test.js.map +0 -1
- package/lib-esm/test/events.test.d.ts +0 -3
- package/lib-esm/test/events.test.js +0 -111
- package/lib-esm/test/events.test.js.map +0 -1
- package/lib-esm/test/externalUsers.test.d.ts +0 -3
- package/lib-esm/test/externalUsers.test.js +0 -35
- package/lib-esm/test/externalUsers.test.js.map +0 -1
- package/lib-esm/test/fileClassifications.test.d.ts +0 -6
- package/lib-esm/test/fileClassifications.test.js +0 -81
- package/lib-esm/test/fileClassifications.test.js.map +0 -1
- package/lib-esm/test/fileMetadata.test.d.ts +0 -3
- package/lib-esm/test/fileMetadata.test.js +0 -247
- package/lib-esm/test/fileMetadata.test.js.map +0 -1
- package/lib-esm/test/fileRequests.test.d.ts +0 -1
- package/lib-esm/test/fileRequests.test.js +0 -50
- package/lib-esm/test/fileRequests.test.js.map +0 -1
- package/lib-esm/test/fileVersionLegalHolds.test.d.ts +0 -3
- package/lib-esm/test/fileVersionLegalHolds.test.js +0 -22
- package/lib-esm/test/fileVersionLegalHolds.test.js.map +0 -1
- package/lib-esm/test/fileVersionRetentions.test.d.ts +0 -3
- package/lib-esm/test/fileVersionRetentions.test.js +0 -90
- package/lib-esm/test/fileVersionRetentions.test.js.map +0 -1
- package/lib-esm/test/fileVersions.test.d.ts +0 -3
- package/lib-esm/test/fileVersions.test.js +0 -144
- package/lib-esm/test/fileVersions.test.js.map +0 -1
- package/lib-esm/test/fileWatermarks.test.d.ts +0 -3
- package/lib-esm/test/fileWatermarks.test.js +0 -31
- package/lib-esm/test/fileWatermarks.test.js.map +0 -1
- package/lib-esm/test/files.test.d.ts +0 -6
- package/lib-esm/test/files.test.js +0 -144
- package/lib-esm/test/files.test.js.map +0 -1
- package/lib-esm/test/folderClassifications.test.d.ts +0 -6
- package/lib-esm/test/folderClassifications.test.js +0 -81
- package/lib-esm/test/folderClassifications.test.js.map +0 -1
- package/lib-esm/test/folderLocks.test.d.ts +0 -3
- package/lib-esm/test/folderLocks.test.js +0 -46
- package/lib-esm/test/folderLocks.test.js.map +0 -1
- package/lib-esm/test/folderMetadata.test.d.ts +0 -3
- package/lib-esm/test/folderMetadata.test.js +0 -247
- package/lib-esm/test/folderMetadata.test.js.map +0 -1
- package/lib-esm/test/folderWatermarks.test.d.ts +0 -3
- package/lib-esm/test/folderWatermarks.test.js +0 -26
- package/lib-esm/test/folderWatermarks.test.js.map +0 -1
- package/lib-esm/test/folders.test.d.ts +0 -3
- package/lib-esm/test/folders.test.js +0 -109
- package/lib-esm/test/folders.test.js.map +0 -1
- package/lib-esm/test/groups.test.d.ts +0 -3
- package/lib-esm/test/groups.test.js +0 -48
- package/lib-esm/test/groups.test.js.map +0 -1
- package/lib-esm/test/integrationMappings.test.d.ts +0 -3
- package/lib-esm/test/integrationMappings.test.js +0 -122
- package/lib-esm/test/integrationMappings.test.js.map +0 -1
- package/lib-esm/test/invites.test.d.ts +0 -1
- package/lib-esm/test/invites.test.js +0 -35
- package/lib-esm/test/invites.test.js.map +0 -1
- package/lib-esm/test/legalHoldPolicies.test.d.ts +0 -3
- package/lib-esm/test/legalHoldPolicies.test.js +0 -71
- package/lib-esm/test/legalHoldPolicies.test.js.map +0 -1
- package/lib-esm/test/legalHoldPolicyAssignments.test.d.ts +0 -3
- package/lib-esm/test/legalHoldPolicyAssignments.test.js +0 -69
- package/lib-esm/test/legalHoldPolicyAssignments.test.js.map +0 -1
- package/lib-esm/test/listCollaborations.test.d.ts +0 -1
- package/lib-esm/test/listCollaborations.test.js +0 -67
- package/lib-esm/test/listCollaborations.test.js.map +0 -1
- package/lib-esm/test/memberships.test.d.ts +0 -3
- package/lib-esm/test/memberships.test.js +0 -61
- package/lib-esm/test/memberships.test.js.map +0 -1
- package/lib-esm/test/metadataCascadePolicies.test.d.ts +0 -3
- package/lib-esm/test/metadataCascadePolicies.test.js +0 -80
- package/lib-esm/test/metadataCascadePolicies.test.js.map +0 -1
- package/lib-esm/test/metadataTemplates.test.d.ts +0 -3
- package/lib-esm/test/metadataTemplates.test.js +0 -185
- package/lib-esm/test/metadataTemplates.test.js.map +0 -1
- package/lib-esm/test/recentItems.test.d.ts +0 -1
- package/lib-esm/test/recentItems.test.js +0 -12
- package/lib-esm/test/recentItems.test.js.map +0 -1
- package/lib-esm/test/retentionPolicies.test.d.ts +0 -3
- package/lib-esm/test/retentionPolicies.test.js +0 -45
- package/lib-esm/test/retentionPolicies.test.js.map +0 -1
- package/lib-esm/test/retentionPolicyAssignments.test.d.ts +0 -3
- package/lib-esm/test/retentionPolicyAssignments.test.js +0 -75
- package/lib-esm/test/retentionPolicyAssignments.test.js.map +0 -1
- package/lib-esm/test/search.test.d.ts +0 -3
- package/lib-esm/test/search.test.js +0 -232
- package/lib-esm/test/search.test.js.map +0 -1
- package/lib-esm/test/sessionTermination.test.d.ts +0 -3
- package/lib-esm/test/sessionTermination.test.js +0 -35
- package/lib-esm/test/sessionTermination.test.js.map +0 -1
- package/lib-esm/test/sharedLinksAppItems.test.d.ts +0 -3
- package/lib-esm/test/sharedLinksAppItems.test.js +0 -20
- package/lib-esm/test/sharedLinksAppItems.test.js.map +0 -1
- package/lib-esm/test/sharedLinksFiles.test.d.ts +0 -3
- package/lib-esm/test/sharedLinksFiles.test.js +0 -63
- package/lib-esm/test/sharedLinksFiles.test.js.map +0 -1
- package/lib-esm/test/sharedLinksFolders.test.d.ts +0 -3
- package/lib-esm/test/sharedLinksFolders.test.js +0 -60
- package/lib-esm/test/sharedLinksFolders.test.js.map +0 -1
- package/lib-esm/test/sharedLinksWebLinks.test.d.ts +0 -3
- package/lib-esm/test/sharedLinksWebLinks.test.js +0 -64
- package/lib-esm/test/sharedLinksWebLinks.test.js.map +0 -1
- package/lib-esm/test/shieldInformationBarrierReports.test.d.ts +0 -1
- package/lib-esm/test/shieldInformationBarrierReports.test.js +0 -51
- package/lib-esm/test/shieldInformationBarrierReports.test.js.map +0 -1
- package/lib-esm/test/shieldInformationBarrierSegmentMembers.test.d.ts +0 -1
- package/lib-esm/test/shieldInformationBarrierSegmentMembers.test.js +0 -53
- package/lib-esm/test/shieldInformationBarrierSegmentMembers.test.js.map +0 -1
- package/lib-esm/test/shieldInformationBarrierSegmentRestrictions.test.d.ts +0 -1
- package/lib-esm/test/shieldInformationBarrierSegmentRestrictions.test.js +0 -71
- package/lib-esm/test/shieldInformationBarrierSegmentRestrictions.test.js.map +0 -1
- package/lib-esm/test/shieldInformationBarrierSegments.test.d.ts +0 -1
- package/lib-esm/test/shieldInformationBarrierSegments.test.js +0 -64
- package/lib-esm/test/shieldInformationBarrierSegments.test.js.map +0 -1
- package/lib-esm/test/shieldInformationBarriers.test.d.ts +0 -1
- package/lib-esm/test/shieldInformationBarriers.test.js +0 -39
- package/lib-esm/test/shieldInformationBarriers.test.js.map +0 -1
- package/lib-esm/test/shieldLists.test.d.ts +0 -4
- package/lib-esm/test/shieldLists.test.js +0 -78
- package/lib-esm/test/shieldLists.test.js.map +0 -1
- package/lib-esm/test/signRequests.test.d.ts +0 -3
- package/lib-esm/test/signRequests.test.js +0 -173
- package/lib-esm/test/signRequests.test.js.map +0 -1
- package/lib-esm/test/signTemplates.test.d.ts +0 -1
- package/lib-esm/test/signTemplates.test.js +0 -38
- package/lib-esm/test/signTemplates.test.js.map +0 -1
- package/lib-esm/test/skills.test.d.ts +0 -3
- package/lib-esm/test/skills.test.js +0 -90
- package/lib-esm/test/skills.test.js.map +0 -1
- package/lib-esm/test/storagePolicicyAssignments.test.d.ts +0 -5
- package/lib-esm/test/storagePolicicyAssignments.test.js +0 -74
- package/lib-esm/test/storagePolicicyAssignments.test.js.map +0 -1
- package/lib-esm/test/storagePolicies.test.d.ts +0 -2
- package/lib-esm/test/storagePolicies.test.js +0 -20
- package/lib-esm/test/storagePolicies.test.js.map +0 -1
- package/lib-esm/test/taskAssignments.test.d.ts +0 -3
- package/lib-esm/test/taskAssignments.test.js +0 -70
- package/lib-esm/test/taskAssignments.test.js.map +0 -1
- package/lib-esm/test/tasks.test.d.ts +0 -3
- package/lib-esm/test/tasks.test.js +0 -58
- package/lib-esm/test/tasks.test.js.map +0 -1
- package/lib-esm/test/termsOfServiceUserStatuses.test.d.ts +0 -1
- package/lib-esm/test/termsOfServiceUserStatuses.test.js +0 -62
- package/lib-esm/test/termsOfServiceUserStatuses.test.js.map +0 -1
- package/lib-esm/test/termsOfServices.test.d.ts +0 -3
- package/lib-esm/test/termsOfServices.test.js +0 -35
- package/lib-esm/test/termsOfServices.test.js.map +0 -1
- package/lib-esm/test/transfer.test.d.ts +0 -3
- package/lib-esm/test/transfer.test.js +0 -34
- package/lib-esm/test/transfer.test.js.map +0 -1
- package/lib-esm/test/trashedFiles.test.d.ts +0 -3
- package/lib-esm/test/trashedFiles.test.js +0 -50
- package/lib-esm/test/trashedFiles.test.js.map +0 -1
- package/lib-esm/test/trashedFolders.test.d.ts +0 -3
- package/lib-esm/test/trashedFolders.test.js +0 -37
- package/lib-esm/test/trashedFolders.test.js.map +0 -1
- package/lib-esm/test/trashedItems.test.d.ts +0 -3
- package/lib-esm/test/trashedItems.test.js +0 -15
- package/lib-esm/test/trashedItems.test.js.map +0 -1
- package/lib-esm/test/trashedWebLinks.test.d.ts +0 -3
- package/lib-esm/test/trashedWebLinks.test.js +0 -45
- package/lib-esm/test/trashedWebLinks.test.js.map +0 -1
- package/lib-esm/test/uploads.test.d.ts +0 -3
- package/lib-esm/test/uploads.test.js +0 -118
- package/lib-esm/test/uploads.test.js.map +0 -1
- package/lib-esm/test/userCollaborations.test.d.ts +0 -3
- package/lib-esm/test/userCollaborations.test.js +0 -146
- package/lib-esm/test/userCollaborations.test.js.map +0 -1
- package/lib-esm/test/users.test.d.ts +0 -3
- package/lib-esm/test/users.test.js +0 -44
- package/lib-esm/test/users.test.js.map +0 -1
- package/lib-esm/test/webhooks.test.d.ts +0 -3
- package/lib-esm/test/webhooks.test.js +0 -222
- package/lib-esm/test/webhooks.test.js.map +0 -1
- package/lib-esm/test/weblinks.test.d.ts +0 -3
- package/lib-esm/test/weblinks.test.js +0 -61
- package/lib-esm/test/weblinks.test.js.map +0 -1
- package/lib-esm/test/workflows.test.d.ts +0 -3
- package/lib-esm/test/workflows.test.js +0 -74
- package/lib-esm/test/workflows.test.js.map +0 -1
- package/lib-esm/test/zipDownloads.test.d.ts +0 -3
- package/lib-esm/test/zipDownloads.test.js +0 -97
- package/lib-esm/test/zipDownloads.test.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,29 +1,8 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
|
|
3
3
|
</p>
|
|
4
|
-
# Versioning Strategy
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
It is currently available on the [sdk-gen](https://github.com/box/box-node-sdk/tree/sdk-gen) branch.
|
|
8
|
-
|
|
9
|
-
v10 is targeted at new users of Box Node SDK and users already working with the generated Box Typescript SDK previously available under the [Box Typescript SDK Gen repository](https://github.com/box/box-typescript-sdk-gen).
|
|
10
|
-
|
|
11
|
-
For users of v3 of the Box Node SDK, no action is required at this time — we’ll be providing an upcoming v4 release that will include code from both versions for a smooth migration path. To avoid unintentional upgrades, pin your version to `box-node-sdk: ^3.8.2` in your `package.json`.
|
|
12
|
-
|
|
13
|
-
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Which Version Should I Use?
|
|
18
|
-
|
|
19
|
-
| Scenario | Recommended Version | Example Dependency |
|
|
20
|
-
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------- |
|
|
21
|
-
| Creating a new application | Use [v10](https://github.com/box/box-node-sdk/tree/sdk-gen) | `npm install box-node-sdk@10` |
|
|
22
|
-
| Existing app using [box-sdk-gen](https://www.npmjs.com/package/box-typescript-sdk-gen) artifact | Upgrade to [v10](https://github.com/box/box-node-sdk/tree/sdk-gen) | `npm install box-node-sdk@10` |
|
|
23
|
-
| Existing app using [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) and planning to use new features | Wait for v4 to start migration process | TBD |
|
|
24
|
-
| Existing app using [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) and not planning changes | Stay on your current version | `npm install box-node-sdk@^3.8.2` |
|
|
25
|
-
|
|
26
|
-
# Box Node SDK
|
|
5
|
+
# Box Node SDK v10
|
|
27
6
|
|
|
28
7
|
[](http://opensource.box.com/badges)
|
|
29
8
|

|
|
@@ -32,9 +11,35 @@ For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://
|
|
|
32
11
|

|
|
33
12
|
[](https://coveralls.io/github/box/box-node-sdk?branch=sdk-gen)
|
|
34
13
|
|
|
35
|
-
|
|
14
|
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
15
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
16
|
+
|
|
17
|
+
- [Introduction](#introduction)
|
|
18
|
+
- [Supported versions](#supported-versions)
|
|
19
|
+
- [Version v4](#version-v4)
|
|
20
|
+
- [Version v10](#version-v10)
|
|
21
|
+
- [Which Version Should I Use?](#which-version-should-i-use)
|
|
22
|
+
- [Installing](#installing)
|
|
23
|
+
- [Getting Started](#getting-started)
|
|
24
|
+
- [Authentication](#authentication)
|
|
25
|
+
- [Documentation](#documentation)
|
|
26
|
+
- [Migration guides](#migration-guides)
|
|
27
|
+
- [Browser Support](#browser-support)
|
|
28
|
+
- [Versioning](#versioning)
|
|
29
|
+
- [Version schedule](#version-schedule)
|
|
30
|
+
- [Contributing](#contributing)
|
|
31
|
+
- [FIPS 140-2 Compliance](#fips-140-2-compliance)
|
|
32
|
+
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
|
|
33
|
+
- [Copyright and License](#copyright-and-license)
|
|
34
|
+
|
|
35
|
+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
# Introduction
|
|
38
|
+
|
|
39
|
+
We are excited to introduce the v10 major release of the Box Node SDK,
|
|
40
|
+
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
|
|
41
|
+
|
|
42
|
+
With this SDK version, you’ll have access to:
|
|
38
43
|
|
|
39
44
|
1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
|
|
40
45
|
2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
|
|
@@ -44,26 +49,43 @@ With this SDK, you’ll have access to:
|
|
|
44
49
|
|
|
45
50
|
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
|
|
46
51
|
|
|
47
|
-
#
|
|
52
|
+
# Supported versions
|
|
48
53
|
|
|
49
|
-
|
|
50
|
-
|
|
54
|
+
To enhance developer experience, we have introduced the new generated codebase through the `sdk-gen` module.
|
|
55
|
+
The `sdk-gen` module is available in two major supported versions: v4 and v10.
|
|
51
56
|
|
|
52
|
-
|
|
53
|
-
- [Table of contents](#table-of-contents)
|
|
54
|
-
- [Installing](#installing)
|
|
55
|
-
- [Getting Started](#getting-started)
|
|
56
|
-
- [Documentation](#documentation)
|
|
57
|
-
- [Browser Support](#browser-support)
|
|
58
|
-
- [Upgrades](#upgrades)
|
|
59
|
-
- [Integration Tests](#integration-tests)
|
|
60
|
-
- [Running integration tests locally](#running-integration-tests-locally)
|
|
61
|
-
- [Create Platform Application](#create-platform-application)
|
|
62
|
-
- [Export configuration](#export-configuration)
|
|
63
|
-
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
|
|
64
|
-
- [Copyright and License](#copyright-and-license)
|
|
57
|
+
## Version v4
|
|
65
58
|
|
|
66
|
-
|
|
59
|
+
In v4 of the Box Node SDK, we are introducing a version that consolidates both the manually written package (legacy SDK) and the generated SDK (currently in v10, formerly known as [box-typescript-sdk-gen](https://github.com/box/box-typescript-sdk-gen)) into a single SDK package for improved usability and maintenance. This allows developers to use both modules within a single project.
|
|
60
|
+
|
|
61
|
+
The codebase for v4 of the Box Node SDK is currently available in the [combined-sdk](https://github.com/box/box-node-sdk/tree/combined-sdk) branch.
|
|
62
|
+
Migration guide for migrating from manually written SDK to generated SDK can be found [here](./migration-guides/from-box-node-sdk-to-sdk-gen.md).
|
|
63
|
+
|
|
64
|
+
Version v4 is intended for:
|
|
65
|
+
|
|
66
|
+
- Existing developers of the Box Node SDK v3 who want to access new API features while keeping their current codebase largely unchanged.
|
|
67
|
+
- Existing developers who are in the process of migrating to `sdk-gen` module, but do not want to move all their code to the new module immediately.
|
|
68
|
+
|
|
69
|
+
## Version v10
|
|
70
|
+
|
|
71
|
+
Starting from v10, the SDK is built entirely on the generated `sdk-gen` module, which fully and exclusively replaces the old `boxsdk` module.
|
|
72
|
+
The codebase for v10 of the Box Node SDK is currently available in the [sdk-gen](https://github.com/box/box-node-sdk/tree/sdk-gen) branch.
|
|
73
|
+
|
|
74
|
+
Version v10 is intended for:
|
|
75
|
+
|
|
76
|
+
- New users of the Box Node SDK.
|
|
77
|
+
- Developers already working with the generated Box TypeScript SDK previously available under the [Box TypeScript SDK Gen repository](https://github.com/box/box-typescript-sdk-gen).
|
|
78
|
+
|
|
79
|
+
## Which Version Should I Use?
|
|
80
|
+
|
|
81
|
+
| Scenario | Recommended Version | Example Dependency |
|
|
82
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------- |
|
|
83
|
+
| Creating a new application | Use [v10](https://github.com/box/box-node-sdk/tree/sdk-gen) | `npm install box-node-sdk@10` |
|
|
84
|
+
| Existing app using [box-typescript-sdk-gen](https://www.npmjs.com/package/box-typescript-sdk-gen) artifact | Migrate to [v10](https://github.com/box/box-node-sdk/tree/sdk-gen) | `npm install box-node-sdk@10` |
|
|
85
|
+
| Existing app using both [box-typescript-sdk-gen](https://www.npmjs.com/package/box-typescript-sdk-gen) and [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) | Upgrade to [v4](https://github.com/box/box-node-sdk/tree/combined-sdk) | `npm install box-node-sdk@^4` |
|
|
86
|
+
| Existing app using v3 of [box-node-sdk](https://www.npmjs.com/package/box-node-sdk) artifact | Upgrade to [v4](https://github.com/box/box-node-sdk/tree/combined-sdk) | `npm install box-node-sdk@^4` |
|
|
87
|
+
|
|
88
|
+
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
|
|
67
89
|
|
|
68
90
|
# Installing
|
|
69
91
|
|
|
@@ -121,59 +143,73 @@ To run the example locally:
|
|
|
121
143
|
4. Provide a fresh Developer Token to the dialog window that shows up upon running the example.
|
|
122
144
|
5. Make sure that you get an alert message that includes your user name.
|
|
123
145
|
|
|
146
|
+
# Authentication
|
|
147
|
+
|
|
148
|
+
Box Node SDK v10 supports multiple authentication methods including Developer Token, OAuth 2.0,
|
|
149
|
+
Client Credentials Grant, and JSON Web Token (JWT).
|
|
150
|
+
|
|
151
|
+
You can find detailed instructions and example code for each authentication method in
|
|
152
|
+
[Authentication](./docs/authentication.md) document.
|
|
153
|
+
|
|
124
154
|
# Documentation
|
|
125
155
|
|
|
126
156
|
Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.com/reference/) for more information.
|
|
127
157
|
|
|
158
|
+
# Migration guides
|
|
159
|
+
|
|
160
|
+
Migration guides which help you to migrate to supported major SDK versions can be found [here](./migration-guides).
|
|
161
|
+
|
|
128
162
|
# Browser Support
|
|
129
163
|
|
|
130
164
|
This SDK works in modern browsers that support ES6+ features. It seamlessly integrates with frontend frameworks like ReactJS, Angular, and NextJS. Check out our example below:
|
|
131
165
|
|
|
132
166
|
- [React Sample App](https://github.com/box-community/box-ts-sdk-react)
|
|
133
167
|
|
|
134
|
-
#
|
|
168
|
+
# Versioning
|
|
169
|
+
|
|
170
|
+
We use a modified version of [Semantic Versioning](https://semver.org/) for all changes. See [version strategy](VERSIONS.md) for details which is effective from 30 July 2022.
|
|
171
|
+
|
|
172
|
+
Currently, we support versions v10 and v4 of the SDK. New features and functionality are added to v10, while the manually written portion of v4 receives bug fixes and security updates only.
|
|
173
|
+
|
|
174
|
+
A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features.
|
|
175
|
+
Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).
|
|
176
|
+
At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade.
|
|
135
177
|
|
|
136
|
-
|
|
178
|
+
We always recommend that all users run the latest available minor release for whatever major version is in use.
|
|
179
|
+
We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.
|
|
137
180
|
|
|
138
|
-
|
|
181
|
+
## Version schedule
|
|
139
182
|
|
|
140
|
-
|
|
183
|
+
| Version | Supported Environments | State | First Release | EOL/Terminated |
|
|
184
|
+
| ------- | ----------------------- | --------- | ------------- | ---------------------- |
|
|
185
|
+
| 10 | Node.js >= 18 | Supported | 17 Sep 2025 | TBD |
|
|
186
|
+
| 4 | Node.js >= 18 | Supported | 23 Oct 2025 | 2027 or v5 is released |
|
|
187
|
+
| 3 | Node.js >= 14 and <= 20 | EOL | 23 May 2023 | 23 Oct 2025 |
|
|
188
|
+
| 2 | Node.js >= 8 and <= 14 | EOL | 29 Sep 2021 | 23 Jul 2023 |
|
|
189
|
+
| 1 | | EOL | 28 Mar 2019 | 29 Sep 2021 |
|
|
141
190
|
|
|
142
|
-
|
|
191
|
+
# Contributing
|
|
143
192
|
|
|
144
|
-
|
|
145
|
-
Console](https://app.box.com/developers/console) with `Server Authentication (with JWT)` selected as authentication method.
|
|
146
|
-
Once created you can edit properties of the application:
|
|
193
|
+
For information on how to contribute to this project, please see [the Contribution guidelines](./CONTRIBUTING.md).
|
|
147
194
|
|
|
148
|
-
|
|
149
|
-
- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.
|
|
195
|
+
# FIPS 140-2 Compliance
|
|
150
196
|
|
|
151
|
-
|
|
197
|
+
The Box Node SDK allows the use of FIPS 140-2 validated SSL libraries, such as OpenSSL 3.0.
|
|
198
|
+
However, some actions are required to enable this functionality.
|
|
152
199
|
|
|
153
|
-
|
|
200
|
+
By default, the version of OpenSSL Node.js includes is not FIPS enabled. Therefore, if you want to use OpenSSL 3.0 with FIPS, you need to [build OpenSSL 3.0 with FIPS enabled](https://github.com/openssl/openssl/blob/master/README-FIPS.md) and then build Node.js use the shared OpenSSL 3.0 library.
|
|
154
201
|
|
|
155
|
-
|
|
156
|
-
download your app configuration settings as JSON.
|
|
157
|
-
2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
|
|
158
|
-
3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
|
|
159
|
-
4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account, `BOX_EXTERNAL_USER_EMAIL` with email of free external user which not belongs to any enterprise and `BOX_EXTERNAL_USER_ID` with its ID.
|
|
160
|
-
5. Set environment variable: `WORKFLOW_FOLDER_ID` with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.
|
|
161
|
-
6. Set environment variable: `APP_ITEM_ASSOCIATION_FILE_ID` to the ID of the file with associated app item and `APP_ITEM_ASSOCIATION_FOLDER_ID` to the ID of the folder with associated app item.
|
|
162
|
-
7. Set environment variable: `APP_ITEM_SHARED_LINK` to the shared link associated with app item.
|
|
163
|
-
8. Set environment variable: `SLACK_AUTOMATION_USER_ID` to the ID of the user responsible for the Slack automation, `SLACK_ORG_ID` to the ID of the Slack organization and `SLACK_PARTNER_ITEM_ID` to the ID of the Slack partner item.
|
|
202
|
+
According to [Node.js OpenSSL Strategy](https://github.com/nodejs/TSC/blob/main/OpenSSL-Strategy.md) document, you can use the OpenSSL 3.0 from Node.js v16 or later.
|
|
164
203
|
|
|
165
204
|
# Questions, Bugs, and Feature Requests?
|
|
166
205
|
|
|
167
|
-
Need to contact us directly? [Browse the issues
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
one](https://github.com/box/box-node-sdk/issues/new) and we will get
|
|
171
|
-
back to you. If you have general questions about the Box API, you can
|
|
172
|
-
post to the [Box Developer Forum](https://forum.box.com/).
|
|
206
|
+
Need to contact us directly? [Browse the issues tickets](https://github.com/box/box-node-sdk/issues)! Or, if that
|
|
207
|
+
doesn't work, [file a new one](https://github.com/box/box-node-sdk/issues/new) and we will get
|
|
208
|
+
back to you. If you have general questions about the Box API, you can post to the [Box Developer Forum](https://community.box.com/box-platform-5).
|
|
173
209
|
|
|
174
210
|
# Copyright and License
|
|
175
211
|
|
|
176
|
-
Copyright
|
|
212
|
+
Copyright 2025 Box, Inc. All rights reserved.
|
|
177
213
|
|
|
178
214
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
179
215
|
you may not use this file except in compliance with the License.
|
package/lib/box/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/box/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;gBACX,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;CAKzE;AACD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;CACrB;AACD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE;QACrB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AACD,qBAAa,WAAY,SAAQ,WAAW;IAC1C,QAAQ,CAAC,WAAW,EAAG,WAAW,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAG,YAAY,CAAC;IACrC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAyB;gBAE5D,MAAM,EAAE,IAAI,CACV,WAAW,EACT,SAAS,GACT,WAAW,GACX,OAAO,GACP,aAAa,GACb,cAAc,GACd,eAAe,CAClB;
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/box/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;gBACX,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;CAKzE;AACD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;CACrB;AACD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAChB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC,CAAC;IACF,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE;QACrB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AACD,qBAAa,WAAY,SAAQ,WAAW;IAC1C,QAAQ,CAAC,WAAW,EAAG,WAAW,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAG,YAAY,CAAC;IACrC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAyB;gBAE5D,MAAM,EAAE,IAAI,CACV,WAAW,EACT,SAAS,GACT,WAAW,GACX,OAAO,GACP,aAAa,GACb,cAAc,GACd,eAAe,CAClB;IAYH,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;IAIxB,QAAQ,IAAI,MAAM;IAIlB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwBP"}
|
package/lib/box/errors.js
CHANGED
|
@@ -17,6 +17,8 @@ class BoxApiError extends BoxSdkError {
|
|
|
17
17
|
super(fields);
|
|
18
18
|
this.dataSanitizer = new logging_1.DataSanitizer({});
|
|
19
19
|
this.name = 'BoxApiError';
|
|
20
|
+
this.requestInfo = fields.requestInfo;
|
|
21
|
+
this.responseInfo = fields.responseInfo;
|
|
20
22
|
if (fields.dataSanitizer) {
|
|
21
23
|
this.dataSanitizer = fields.dataSanitizer;
|
|
22
24
|
}
|
package/lib/box/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/box/errors.ts"],"names":[],"mappings":";;;AACA,+CAAwD;AACxD,6CAA4C;AAC5C,iDAAoD;AAEpD,MAAa,WAAY,SAAQ,2BAAkB;IAGjD,YAAY,MAA4D;QACtE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACF;AARD,kCAQC;AA0BD,MAAa,WAAY,SAAQ,WAAW;IAI1C,YACE,MAQC;QAED,KAAK,CAAC,MAAM,CAAC,CAAC;QAZP,kBAAa,GAAkB,IAAI,uBAAa,CAAC,EAAE,CAAC,CAAC;QAa5D,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,CAAC;QACD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,CAAC,eAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE;gBACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW;gBACzC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;gBACrE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;aAC5B;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU;gBACxC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;gBACtE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;gBAC7D,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI;gBAC5B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,WAAW;gBAC1C,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS;gBACtC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO;aACnC;SACF,CAAC;IACJ,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/box/errors.ts"],"names":[],"mappings":";;;AACA,+CAAwD;AACxD,6CAA4C;AAC5C,iDAAoD;AAEpD,MAAa,WAAY,SAAQ,2BAAkB;IAGjD,YAAY,MAA4D;QACtE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACF;AARD,kCAQC;AA0BD,MAAa,WAAY,SAAQ,WAAW;IAI1C,YACE,MAQC;QAED,KAAK,CAAC,MAAM,CAAC,CAAC;QAZP,kBAAa,GAAkB,IAAI,uBAAa,CAAC,EAAE,CAAC,CAAC;QAa5D,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,CAAC;QACD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,CAAC,eAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE;gBACX,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC/B,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG;gBACzB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,WAAW;gBACzC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;gBACrE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;aAC5B;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU;gBACxC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;gBACtE,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;gBAC7D,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI;gBAC5B,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,WAAW;gBAC1C,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS;gBACtC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO;aACnC;SACF,CAAC;IACJ,CAAC;CACF;AAzDD,kCAyDC"}
|