feat: Assign default value to fields and args of type enum with only one value (box/box-codegen#465) (#131)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "fd9728e", "specHash": "1698c95", "version": "0.5.2" }
+{ "engineHash": "7b699f4", "specHash": "1698c95", "version": "0.5.2" }

docs/classifications.md

@@ -58,10 +58,7 @@ See the endpoint docs at
 
 ```ts
 await client.classifications.addClassification([
-  {
-    op: 'addEnumOption' as AddClassificationRequestBodyOpField,
-    fieldKey:
-      'Box__Security__Classification__Key' as AddClassificationRequestBodyFieldKeyField,
+  new AddClassificationRequestBody({
     data: {
       key: getUuid(),
       staticConfig: {
@@ -71,7 +68,7 @@ await client.classifications.addClassification([
         } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField,
       } satisfies AddClassificationRequestBodyDataStaticConfigField,
     } satisfies AddClassificationRequestBodyDataField,
-  } satisfies AddClassificationRequestBody,
+  }),
 ]);
 ```
 
@@ -110,10 +107,7 @@ See the endpoint docs at
 
 ```ts
 await client.classifications.updateClassification([
-  {
-    op: 'editEnumOption' as UpdateClassificationRequestBodyOpField,
-    fieldKey:
-      'Box__Security__Classification__Key' as UpdateClassificationRequestBodyFieldKeyField,
+  new UpdateClassificationRequestBody({
     enumOptionKey: classification.key,
     data: {
       key: updatedClassificationName,
@@ -124,7 +118,7 @@ await client.classifications.updateClassification([
         } satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField,
       } satisfies UpdateClassificationRequestBodyDataStaticConfigField,
     } satisfies UpdateClassificationRequestBodyDataField,
-  } satisfies UpdateClassificationRequestBody,
+  }),
 ]);
 ```
 

docs/fileClassifications.md

@@ -100,11 +100,9 @@ See the endpoint docs at
 
 ```ts
 await client.fileClassifications.updateClassificationOnFile(file.id, [
-  {
-    op: 'replace' as UpdateClassificationOnFileRequestBodyOpField,
-    path: '/Box__Security__Classification__Key' as UpdateClassificationOnFileRequestBodyPathField,
+  new UpdateClassificationOnFileRequestBody({
     value: secondClassification.key,
-  } satisfies UpdateClassificationOnFileRequestBody,
+  }),
 ]);
 ```
 

docs/fileWatermarks.md

@@ -48,9 +48,9 @@ See the endpoint docs at
 
 ```ts
 await client.fileWatermarks.updateFileWatermark(file.id, {
-  watermark: {
+  watermark: new UpdateFileWatermarkRequestBodyWatermarkField({
     imprint: 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField,
-  } satisfies UpdateFileWatermarkRequestBodyWatermarkField,
+  }),
 } satisfies UpdateFileWatermarkRequestBody);
 ```
 

docs/folderClassifications.md

@@ -100,11 +100,9 @@ See the endpoint docs at
 
 ```ts
 await client.folderClassifications.updateClassificationOnFolder(folder.id, [
-  {
-    op: 'replace' as UpdateClassificationOnFolderRequestBodyOpField,
-    path: '/Box__Security__Classification__Key' as UpdateClassificationOnFolderRequestBodyPathField,
+  new UpdateClassificationOnFolderRequestBody({
     value: secondClassification.key,
-  } satisfies UpdateClassificationOnFolderRequestBody,
+  }),
 ]);
 ```
 

docs/folderWatermarks.md

@@ -48,9 +48,9 @@ See the endpoint docs at
 
 ```ts
 await client.folderWatermarks.updateFolderWatermark(folder.id, {
-  watermark: {
+  watermark: new UpdateFolderWatermarkRequestBodyWatermarkField({
     imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField,
-  } satisfies UpdateFolderWatermarkRequestBodyWatermarkField,
+  }),
 } satisfies UpdateFolderWatermarkRequestBody);
 ```
 

docs/integrationMappings.md

@@ -55,15 +55,11 @@ See the endpoint docs at
 
 ```ts
 await userClient.integrationMappings.createSlackIntegrationMapping({
-  partnerItem: {
-    type: 'channel' as IntegrationMappingPartnerItemSlackTypeField,
+  partnerItem: new IntegrationMappingPartnerItemSlack({
     id: partnerItemId,
     slackOrgId: slackOrgId,
-  } satisfies IntegrationMappingPartnerItemSlack,
-  boxItem: {
-    id: folder.id,
-    type: 'folder' as IntegrationMappingBoxItemSlackTypeField,
-  } satisfies IntegrationMappingBoxItemSlack,
+  }),
+  boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
 } satisfies IntegrationMappingSlackCreateRequest);
 ```
 

docs/shieldInformationBarrierSegmentMembers.md

@@ -126,10 +126,7 @@ await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarri
       id: segment.id!,
       type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField,
     } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField,
-    user: {
-      id: getEnvVar('USER_ID'),
-      type: 'user' as UserBaseTypeField,
-    } satisfies UserBase,
+    user: new UserBase({ id: getEnvVar('USER_ID') }),
   } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody
 );
 ```

docs/shieldInformationBarrierSegmentRestrictions.md

@@ -122,7 +122,7 @@ See the endpoint docs at
 
 ```ts
 await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction(
-  {
+  new CreateShieldInformationBarrierSegmentRestrictionRequestBody({
     restrictedSegment: {
       id: segmentToRestrictId,
       type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField,
@@ -132,7 +132,7 @@ await client.shieldInformationBarrierSegmentRestrictions.createShieldInformation
       type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField,
     } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField,
     type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField,
-  } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBody
+  })
 );
 ```
 

docs/shieldInformationBarriers.md

@@ -119,10 +119,7 @@ See the endpoint docs at
 
 ```ts
 await client.shieldInformationBarriers.createShieldInformationBarrier({
-  enterprise: {
-    id: enterpriseId,
-    type: 'enterprise' as EnterpriseBaseTypeField,
-  } satisfies EnterpriseBase,
+  enterprise: { id: enterpriseId } satisfies EnterpriseBase,
 } satisfies CreateShieldInformationBarrierRequestBody);
 ```
 

docs/signRequests.md

@@ -148,13 +148,8 @@ await client.signRequests.createSignRequest({
       signerGroupId: 'user',
     } satisfies SignRequestCreateSigner,
   ],
-  parentFolder: {
-    id: destinationFolder.id,
-    type: 'folder' as FolderBaseTypeField,
-  } satisfies FolderMini,
-  sourceFiles: [
-    { id: fileToSign.id, type: 'file' as FileBaseTypeField } satisfies FileBase,
-  ],
+  parentFolder: new FolderMini({ id: destinationFolder.id }),
+  sourceFiles: [new FileBase({ id: fileToSign.id })],
 } satisfies SignRequestCreateRequest);
 ```
 

docs/skills.md

@@ -60,14 +60,14 @@ await client.skills.createBoxSkillCardsOnFile(file.id, {
         code: 'license-plates',
         message: titleMessage,
       } satisfies KeywordSkillCardSkillCardTitleField,
-      skill: {
+      skill: new KeywordSkillCardSkillField({
         id: skillId,
         type: 'service' as KeywordSkillCardSkillTypeField,
-      } satisfies KeywordSkillCardSkillField,
-      invocation: {
+      }),
+      invocation: new KeywordSkillCardInvocationField({
         id: invocationId,
         type: 'skill_invocation' as KeywordSkillCardInvocationTypeField,
-      } satisfies KeywordSkillCardInvocationField,
+      }),
       entries: [{ text: 'DN86 BOX' } satisfies KeywordSkillCardEntriesField],
     } satisfies KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard,
   ],
@@ -108,23 +108,23 @@ await client.skills.updateBoxSkillCardsOnFile(file.id, [
   {
     op: 'replace' as UpdateBoxSkillCardsOnFileRequestBodyOpField,
     path: '/cards/0',
-    value: {
+    value: new KeywordSkillCard({
       type: 'skill_card' as KeywordSkillCardTypeField,
       skillCardType: 'keyword' as KeywordSkillCardSkillCardTypeField,
       skillCardTitle: {
         code: 'license-plates',
         message: updatedTitleMessage,
       } satisfies KeywordSkillCardSkillCardTitleField,
-      skill: {
+      skill: new KeywordSkillCardSkillField({
         id: skillId,
         type: 'service' as KeywordSkillCardSkillTypeField,
-      } satisfies KeywordSkillCardSkillField,
-      invocation: {
+      }),
+      invocation: new KeywordSkillCardInvocationField({
         id: invocationId,
         type: 'skill_invocation' as KeywordSkillCardInvocationTypeField,
-      } satisfies KeywordSkillCardInvocationField,
+      }),
       entries: [{ text: 'DN86 BOX' } satisfies KeywordSkillCardEntriesField],
-    } satisfies KeywordSkillCard,
+    }),
   } satisfies UpdateBoxSkillCardsOnFileRequestBody,
 ]);
 ```

docs/storagePolicyAssignments.md

@@ -54,10 +54,9 @@ See the endpoint docs at
 
 ```ts
 await client.storagePolicyAssignments.createStoragePolicyAssignment({
-  storagePolicy: {
-    id: policyId,
-    type: 'storage_policy' as CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField,
-  } satisfies CreateStoragePolicyAssignmentRequestBodyStoragePolicyField,
+  storagePolicy: new CreateStoragePolicyAssignmentRequestBodyStoragePolicyField(
+    { id: policyId }
+  ),
   assignedTo: {
     id: userId,
     type: 'user' as CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField,
@@ -127,10 +126,10 @@ See the endpoint docs at
 await client.storagePolicyAssignments.updateStoragePolicyAssignmentById(
   storagePolicyAssignment.id,
   {
-    storagePolicy: {
-      id: storagePolicy2.id,
-      type: 'storage_policy' as UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField,
-    } satisfies UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField,
+    storagePolicy:
+      new UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField({
+        id: storagePolicy2.id,
+      }),
   } satisfies UpdateStoragePolicyAssignmentByIdRequestBody
 );
 ```

docs/taskAssignments.md

@@ -53,10 +53,10 @@ See the endpoint docs at
 
 ```ts
 await client.taskAssignments.createTaskAssignment({
-  task: {
+  task: new CreateTaskAssignmentRequestBodyTaskField({
     type: 'task' as CreateTaskAssignmentRequestBodyTaskTypeField,
     id: task.id!,
-  } satisfies CreateTaskAssignmentRequestBodyTaskField,
+  }),
   assignTo: {
     id: currentUser.id,
   } satisfies CreateTaskAssignmentRequestBodyAssignToField,

docs/termsOfServiceUserStatuses.md

@@ -52,14 +52,10 @@ See the endpoint docs at
 
 ```ts
 await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser({
-  tos: {
-    type: 'terms_of_service' as CreateTermsOfServiceStatusForUserRequestBodyTosTypeField,
-    id: tos.id,
-  } satisfies CreateTermsOfServiceStatusForUserRequestBodyTosField,
-  user: {
-    type: 'user' as CreateTermsOfServiceStatusForUserRequestBodyUserTypeField,
+  tos: new CreateTermsOfServiceStatusForUserRequestBodyTosField({ id: tos.id }),
+  user: new CreateTermsOfServiceStatusForUserRequestBodyUserField({
     id: user.id,
-  } satisfies CreateTermsOfServiceStatusForUserRequestBodyUserField,
+  }),
   isAccepted: false,
 } satisfies CreateTermsOfServiceStatusForUserRequestBody);
 ```