box-node-sdk 10.1.0 → 10.3.0

package/src/managers/metadataTemplates.ts

@@ -51,7 +51,7 @@ export class GetMetadataTemplatesByInstanceIdOptionals {
 }
 export interface GetMetadataTemplatesByInstanceIdOptionalsInput {
   readonly headers?: GetMetadataTemplatesByInstanceIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetMetadataTemplateOptionals {
   readonly headers: GetMetadataTemplateHeaders = new GetMetadataTemplateHeaders(
@@ -77,7 +77,7 @@ export class GetMetadataTemplateOptionals {
 }
 export interface GetMetadataTemplateOptionalsInput {
   readonly headers?: GetMetadataTemplateHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateMetadataTemplateOptionals {
   readonly headers: UpdateMetadataTemplateHeaders =
@@ -102,7 +102,7 @@ export class UpdateMetadataTemplateOptionals {
 }
 export interface UpdateMetadataTemplateOptionalsInput {
   readonly headers?: UpdateMetadataTemplateHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteMetadataTemplateOptionals {
   readonly headers: DeleteMetadataTemplateHeaders =
@@ -127,7 +127,7 @@ export class DeleteMetadataTemplateOptionals {
 }
 export interface DeleteMetadataTemplateOptionalsInput {
   readonly headers?: DeleteMetadataTemplateHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetMetadataTemplateByIdOptionals {
   readonly headers: GetMetadataTemplateByIdHeaders =
@@ -152,7 +152,7 @@ export class GetMetadataTemplateByIdOptionals {
 }
 export interface GetMetadataTemplateByIdOptionalsInput {
   readonly headers?: GetMetadataTemplateByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateMetadataTemplateOptionals {
   readonly headers: CreateMetadataTemplateHeaders =
@@ -177,7 +177,7 @@ export class CreateMetadataTemplateOptionals {
 }
 export interface CreateMetadataTemplateOptionalsInput {
   readonly headers?: CreateMetadataTemplateHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface GetMetadataTemplatesByInstanceIdQueryParams {
   /**
@@ -211,11 +211,9 @@ export class GetMetadataTemplatesByInstanceIdHeaders {
 export interface GetMetadataTemplatesByInstanceIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type GetMetadataTemplateScope = 'global' | 'enterprise' | string;
 export class GetMetadataTemplateHeaders {
@@ -236,11 +234,9 @@ export class GetMetadataTemplateHeaders {
 export interface GetMetadataTemplateHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type UpdateMetadataTemplateScope = 'global' | 'enterprise' | string;
 export type UpdateMetadataTemplateRequestBodyOpField =
@@ -313,11 +309,9 @@ export class UpdateMetadataTemplateHeaders {
 export interface UpdateMetadataTemplateHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type DeleteMetadataTemplateScope = 'global' | 'enterprise' | string;
 export class DeleteMetadataTemplateHeaders {
@@ -338,11 +332,9 @@ export class DeleteMetadataTemplateHeaders {
 export interface DeleteMetadataTemplateHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class GetMetadataTemplateByIdHeaders {
   /**
@@ -362,11 +354,9 @@ export class GetMetadataTemplateByIdHeaders {
 export interface GetMetadataTemplateByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export interface GetGlobalMetadataTemplatesQueryParams {
   /**
@@ -397,11 +387,9 @@ export class GetGlobalMetadataTemplatesHeaders {
 export interface GetGlobalMetadataTemplatesHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export interface GetEnterpriseMetadataTemplatesQueryParams {
   /**
@@ -432,18 +420,17 @@ export class GetEnterpriseMetadataTemplatesHeaders {
 export interface GetEnterpriseMetadataTemplatesHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type CreateMetadataTemplateRequestBodyFieldsTypeField =
   | 'string'
   | 'float'
   | 'date'
   | 'enum'
-  | 'multiSelect';
+  | 'multiSelect'
+  | 'taxonomy';
 export interface CreateMetadataTemplateRequestBodyFieldsOptionsField {
   /**
    * The text value of the option. This represents both the display name of the
@@ -451,15 +438,28 @@ export interface CreateMetadataTemplateRequestBodyFieldsOptionsField {
   readonly key: string;
   readonly rawData?: SerializedData;
 }
+export interface CreateMetadataTemplateRequestBodyFieldsOptionsRulesField {
+  /**
+   * Whether to allow users to select multiple values. */
+  readonly multiSelect?: boolean;
+  /**
+   * An array of integers defining which levels of the taxonomy are
+   * selectable by users. */
+  readonly selectableLevels?: readonly number[];
+  readonly rawData?: SerializedData;
+}
 export interface CreateMetadataTemplateRequestBodyFieldsField {
   /**
    * The type of field. The basic fields are a `string` field for text, a
-   * `float` field for numbers, and a `date` fields to present the user with a
+   * `float` field for numbers, and a `date` field to present the user with a
    * date-time picker.
    *
    * Additionally, metadata templates support an `enum` field for a basic list
    * of items, and ` multiSelect` field for a similar list of items where the
-   * user can select more than one value. */
+   * user can select more than one value.
+   *
+   * Metadata taxonomies are also supported as a `taxonomy` field type
+   * with a specific set of additional properties, which describe its structure. */
   readonly type: CreateMetadataTemplateRequestBodyFieldsTypeField;
   /**
    * A unique identifier for the field. The identifier must
@@ -480,6 +480,18 @@ export interface CreateMetadataTemplateRequestBodyFieldsField {
    * A list of options for this field. This is used in combination with the
    * `enum` and `multiSelect` field types. */
   readonly options?: readonly CreateMetadataTemplateRequestBodyFieldsOptionsField[];
+  /**
+   * The unique key of the metadata taxonomy to use for this taxonomy field.
+   * This property is required when the field `type` is set to `taxonomy`. */
+  readonly taxonomyKey?: string;
+  /**
+   * The namespace of the metadata taxonomy to use for this taxonomy field.
+   * This property is required when the field `type` is set to `taxonomy`. */
+  readonly namespace?: string;
+  /**
+   * An object defining additional rules for the options of the taxonomy field.
+   * This property is required when the field `type` is set to `taxonomy`. */
+  readonly optionsRules?: CreateMetadataTemplateRequestBodyFieldsOptionsRulesField;
   readonly rawData?: SerializedData;
 }
 export interface CreateMetadataTemplateRequestBody {
@@ -536,11 +548,9 @@ export class CreateMetadataTemplateHeaders {
 export interface CreateMetadataTemplateHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class MetadataTemplatesManager {
   readonly auth?: Authentication;
@@ -651,9 +661,9 @@ export class MetadataTemplatesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/metadata_templates/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
             '/schema',
           ) as string,
           method: 'GET',
@@ -707,9 +717,9 @@ export class MetadataTemplatesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/metadata_templates/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
             '/schema',
           ) as string,
           method: 'PUT',
@@ -760,9 +770,9 @@ export class MetadataTemplatesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/metadata_templates/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
             '/schema',
           ) as string,
           method: 'DELETE',
@@ -802,7 +812,7 @@ export class MetadataTemplatesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/metadata_templates/',
-            toString(templateId) as string,
+            (toString(templateId) as string)!,
           ) as string,
           method: 'GET',
           headers: headersMap,
@@ -1290,6 +1300,9 @@ export function deserializeCreateMetadataTemplateRequestBodyFieldsTypeField(
   if (val == 'multiSelect') {
     return val;
   }
+  if (val == 'taxonomy') {
+    return val;
+  }
   throw new BoxSdkError({
     message:
       "Can't deserialize CreateMetadataTemplateRequestBodyFieldsTypeField",
@@ -1326,6 +1339,61 @@ export function deserializeCreateMetadataTemplateRequestBodyFieldsOptionsField(
     key: key,
   } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField;
 }
+export function serializeCreateMetadataTemplateRequestBodyFieldsOptionsRulesField(
+  val: CreateMetadataTemplateRequestBodyFieldsOptionsRulesField,
+): SerializedData {
+  return {
+    ['multiSelect']: val.multiSelect,
+    ['selectableLevels']:
+      val.selectableLevels == void 0
+        ? val.selectableLevels
+        : (val.selectableLevels.map(function (item: number): SerializedData {
+            return item;
+          }) as readonly any[]),
+  };
+}
+export function deserializeCreateMetadataTemplateRequestBodyFieldsOptionsRulesField(
+  val: SerializedData,
+): CreateMetadataTemplateRequestBodyFieldsOptionsRulesField {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting a map for "CreateMetadataTemplateRequestBodyFieldsOptionsRulesField"',
+    });
+  }
+  if (!(val.multiSelect == void 0) && !sdIsBoolean(val.multiSelect)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting boolean for "multiSelect" of type "CreateMetadataTemplateRequestBodyFieldsOptionsRulesField"',
+    });
+  }
+  const multiSelect: undefined | boolean =
+    val.multiSelect == void 0 ? void 0 : val.multiSelect;
+  if (!(val.selectableLevels == void 0) && !sdIsList(val.selectableLevels)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting array for "selectableLevels" of type "CreateMetadataTemplateRequestBodyFieldsOptionsRulesField"',
+    });
+  }
+  const selectableLevels: undefined | readonly number[] =
+    val.selectableLevels == void 0
+      ? void 0
+      : sdIsList(val.selectableLevels)
+        ? (val.selectableLevels.map(function (itm: SerializedData): number {
+            if (!sdIsNumber(itm)) {
+              throw new BoxSdkError({
+                message:
+                  'Expecting number for "CreateMetadataTemplateRequestBodyFieldsOptionsRulesField"',
+              });
+            }
+            return itm;
+          }) as readonly any[])
+        : [];
+  return {
+    multiSelect: multiSelect,
+    selectableLevels: selectableLevels,
+  } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsRulesField;
+}
 export function serializeCreateMetadataTemplateRequestBodyFieldsField(
   val: CreateMetadataTemplateRequestBodyFieldsField,
 ): SerializedData {
@@ -1347,6 +1415,14 @@ export function serializeCreateMetadataTemplateRequestBodyFieldsField(
               item,
             );
           }) as readonly any[]),
+    ['taxonomyKey']: val.taxonomyKey,
+    ['namespace']: val.namespace,
+    ['optionsRules']:
+      val.optionsRules == void 0
+        ? val.optionsRules
+        : serializeCreateMetadataTemplateRequestBodyFieldsOptionsRulesField(
+            val.optionsRules,
+          ),
   };
 }
 export function deserializeCreateMetadataTemplateRequestBodyFieldsField(
@@ -1428,6 +1504,30 @@ export function deserializeCreateMetadataTemplateRequestBodyFieldsField(
             );
           }) as readonly any[])
         : [];
+  if (!(val.taxonomyKey == void 0) && !sdIsString(val.taxonomyKey)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "taxonomyKey" of type "CreateMetadataTemplateRequestBodyFieldsField"',
+    });
+  }
+  const taxonomyKey: undefined | string =
+    val.taxonomyKey == void 0 ? void 0 : val.taxonomyKey;
+  if (!(val.namespace == void 0) && !sdIsString(val.namespace)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "namespace" of type "CreateMetadataTemplateRequestBodyFieldsField"',
+    });
+  }
+  const namespace: undefined | string =
+    val.namespace == void 0 ? void 0 : val.namespace;
+  const optionsRules:
+    | undefined
+    | CreateMetadataTemplateRequestBodyFieldsOptionsRulesField =
+    val.optionsRules == void 0
+      ? void 0
+      : deserializeCreateMetadataTemplateRequestBodyFieldsOptionsRulesField(
+          val.optionsRules,
+        );
   return {
     type: type,
     key: key,
@@ -1435,6 +1535,9 @@ export function deserializeCreateMetadataTemplateRequestBodyFieldsField(
     description: description,
     hidden: hidden,
     options: options,
+    taxonomyKey: taxonomyKey,
+    namespace: namespace,
+    optionsRules: optionsRules,
   } satisfies CreateMetadataTemplateRequestBodyFieldsField;
 }
 export function serializeCreateMetadataTemplateRequestBody(

package/src/managers/recentItems.ts

@@ -62,11 +62,9 @@ export class GetRecentItemsHeaders {
 export interface GetRecentItemsHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class RecentItemsManager {
   readonly auth?: Authentication;

package/src/managers/retentionPolicies.ts

@@ -54,7 +54,7 @@ export class CreateRetentionPolicyOptionals {
 }
 export interface CreateRetentionPolicyOptionalsInput {
   readonly headers?: CreateRetentionPolicyHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetRetentionPolicyByIdOptionals {
   readonly queryParams: GetRetentionPolicyByIdQueryParams =
@@ -88,7 +88,7 @@ export class GetRetentionPolicyByIdOptionals {
 export interface GetRetentionPolicyByIdOptionalsInput {
   readonly queryParams?: GetRetentionPolicyByIdQueryParams;
   readonly headers?: GetRetentionPolicyByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateRetentionPolicyByIdOptionals {
   readonly requestBody: UpdateRetentionPolicyByIdRequestBody =
@@ -122,7 +122,7 @@ export class UpdateRetentionPolicyByIdOptionals {
 export interface UpdateRetentionPolicyByIdOptionalsInput {
   readonly requestBody?: UpdateRetentionPolicyByIdRequestBody;
   readonly headers?: UpdateRetentionPolicyByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteRetentionPolicyByIdOptionals {
   readonly headers: DeleteRetentionPolicyByIdHeaders =
@@ -150,7 +150,7 @@ export class DeleteRetentionPolicyByIdOptionals {
 }
 export interface DeleteRetentionPolicyByIdOptionalsInput {
   readonly headers?: DeleteRetentionPolicyByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export type GetRetentionPoliciesQueryParamsPolicyTypeField =
   | 'finite'
@@ -204,11 +204,9 @@ export class GetRetentionPoliciesHeaders {
 export interface GetRetentionPoliciesHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type CreateRetentionPolicyRequestBodyPolicyTypeField =
   | 'finite'
@@ -301,11 +299,9 @@ export class CreateRetentionPolicyHeaders {
 export interface CreateRetentionPolicyHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export interface GetRetentionPolicyByIdQueryParams {
   /**
@@ -338,11 +334,9 @@ export class GetRetentionPolicyByIdHeaders {
 export interface GetRetentionPolicyByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export interface UpdateRetentionPolicyByIdRequestBody {
   /**
@@ -429,11 +423,9 @@ export class UpdateRetentionPolicyByIdHeaders {
 export interface UpdateRetentionPolicyByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class DeleteRetentionPolicyByIdHeaders {
   /**
@@ -453,11 +445,9 @@ export class DeleteRetentionPolicyByIdHeaders {
 export interface DeleteRetentionPolicyByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class RetentionPoliciesManager {
   readonly auth?: Authentication;
@@ -613,7 +603,7 @@ export class RetentionPoliciesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/retention_policies/',
-            toString(retentionPolicyId) as string,
+            (toString(retentionPolicyId) as string)!,
           ) as string,
           method: 'GET',
           params: queryParamsMap,
@@ -658,7 +648,7 @@ export class RetentionPoliciesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/retention_policies/',
-            toString(retentionPolicyId) as string,
+            (toString(retentionPolicyId) as string)!,
           ) as string,
           method: 'PUT',
           headers: headersMap,
@@ -702,7 +692,7 @@ export class RetentionPoliciesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/retention_policies/',
-            toString(retentionPolicyId) as string,
+            (toString(retentionPolicyId) as string)!,
           ) as string,
           method: 'DELETE',
           headers: headersMap,