feat: pack optional arguments of API methods into a new record(box/box-codegen#471) (#156)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "267eec8", "specHash": "1698c95", "version": "0.5.3" }
+{ "engineHash": "81071a6", "specHash": "1698c95", "version": "0.5.3" }

docs/authorization.md

@@ -26,10 +26,8 @@ _Currently we don't have an example for calling `authorizeUser` in integration t
 
 - queryParams `AuthorizeUserQueryParams`
   - Query parameters of authorizeUser method
-- headersInput `AuthorizeUserHeadersInput`
-  - Headers of authorizeUser method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `AuthorizeUserOptionalsInput`
+  -
 
 ### Returns
 
@@ -63,10 +61,8 @@ _Currently we don't have an example for calling `requestAccessToken` in integrat
 
 - requestBody `PostOAuth2Token`
   - Request body of requestAccessToken method
-- headersInput `RequestAccessTokenHeadersInput`
-  - Headers of requestAccessToken method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `RequestAccessTokenOptionalsInput`
+  -
 
 ### Returns
 
@@ -91,10 +87,8 @@ _Currently we don't have an example for calling `refreshAccessToken` in integrat
 
 - requestBodyInput `PostOAuth2TokenRefreshAccessTokenInput`
   - Request body of refreshAccessToken method
-- headersInput `RefreshAccessTokenHeadersInput`
-  - Headers of refreshAccessToken method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `RefreshAccessTokenOptionalsInput`
+  -
 
 ### Returns
 
@@ -120,10 +114,8 @@ _Currently we don't have an example for calling `revokeAccessToken` in integrati
 
 - requestBody `PostOAuth2Revoke`
   - Request body of revokeAccessToken method
-- headersInput `RevokeAccessTokenHeadersInput`
-  - Headers of revokeAccessToken method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `RevokeAccessTokenOptionalsInput`
+  -
 
 ### Returns
 

docs/avatars.md

@@ -23,10 +23,8 @@ await client.avatars.getUserAvatar(user.id);
 
 - userId `string`
   - The ID of the user. Example: "12345"
-- headersInput `GetUserAvatarHeadersInput`
-  - Headers of getUserAvatar method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetUserAvatarOptionalsInput`
+  -
 
 ### Returns
 
@@ -63,10 +61,8 @@ await client.avatars.createUserAvatar(user.id, {
   - The ID of the user. Example: "12345"
 - requestBody `CreateUserAvatarRequestBody`
   - Request body of createUserAvatar method
-- headersInput `CreateUserAvatarHeadersInput`
-  - Headers of createUserAvatar method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateUserAvatarOptionalsInput`
+  -
 
 ### Returns
 
@@ -96,10 +92,8 @@ await client.avatars.deleteUserAvatar(user.id);
 
 - userId `string`
   - The ID of the user. Example: "12345"
-- headersInput `DeleteUserAvatarHeadersInput`
-  - Headers of deleteUserAvatar method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `DeleteUserAvatarOptionalsInput`
+  -
 
 ### Returns
 

docs/chunkedUploads.md

@@ -29,19 +29,19 @@ await this.createFileUploadSession(
     fileSize: fileSize,
     folderId: parentFolderId,
   } satisfies CreateFileUploadSessionRequestBody,
-  {} satisfies CreateFileUploadSessionHeadersInput,
-  cancellationToken
+  {
+    headers: new CreateFileUploadSessionHeaders({}),
+    cancellationToken: cancellationToken,
+  } satisfies CreateFileUploadSessionOptionalsInput
 );
 ```
 
 ### Arguments
 
 - requestBody `CreateFileUploadSessionRequestBody`
   - Request body of createFileUploadSession method
-- headersInput `CreateFileUploadSessionHeadersInput`
-  - Headers of createFileUploadSession method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateFileUploadSessionOptionalsInput`
+  -
 
 ### Returns
 
@@ -66,10 +66,8 @@ _Currently we don't have an example for calling `createFileUploadSessionForExist
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - requestBody `CreateFileUploadSessionForExistingFileRequestBody`
   - Request body of createFileUploadSessionForExistingFile method
-- headersInput `CreateFileUploadSessionForExistingFileHeadersInput`
-  - Headers of createFileUploadSessionForExistingFile method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateFileUploadSessionForExistingFileOptionalsInput`
+  -
 
 ### Returns
 
@@ -89,21 +87,18 @@ See the endpoint docs at
 <!-- sample get_files_upload_sessions_id -->
 
 ```ts
-await this.getFileUploadSessionById(
-  uploadSessionId,
-  {} satisfies GetFileUploadSessionByIdHeadersInput,
-  cancellationToken
-);
+await this.getFileUploadSessionById(uploadSessionId, {
+  headers: new GetFileUploadSessionByIdHeaders({}),
+  cancellationToken: cancellationToken,
+} satisfies GetFileUploadSessionByIdOptionalsInput);
 ```
 
 ### Arguments
 
 - uploadSessionId `string`
   - The ID of the upload session. Example: "D5E3F7A"
-- headersInput `GetFileUploadSessionByIdHeadersInput`
-  - Headers of getFileUploadSessionById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetFileUploadSessionByIdOptionalsInput`
+  -
 
 ### Returns
 
@@ -141,8 +136,8 @@ await this.uploadFilePart(
   - Request body of uploadFilePart method
 - headersInput `UploadFilePartHeadersInput`
   - Headers of uploadFilePart method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `UploadFilePartOptionalsInput`
+  -
 
 ### Returns
 
@@ -167,10 +162,8 @@ _Currently we don't have an example for calling `deleteFileUploadSessionById` in
 
 - uploadSessionId `string`
   - The ID of the upload session. Example: "D5E3F7A"
-- headersInput `DeleteFileUploadSessionByIdHeadersInput`
-  - Headers of deleteFileUploadSessionById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `DeleteFileUploadSessionByIdOptionalsInput`
+  -
 
 ### Returns
 
@@ -192,24 +185,19 @@ See the endpoint docs at
 <!-- sample get_files_upload_sessions_id_parts -->
 
 ```ts
-await this.getFileUploadSessionParts(
-  uploadSessionId,
-  {} satisfies GetFileUploadSessionPartsQueryParams,
-  {} satisfies GetFileUploadSessionPartsHeadersInput,
-  cancellationToken
-);
+await this.getFileUploadSessionParts(uploadSessionId, {
+  queryParams: {} satisfies GetFileUploadSessionPartsQueryParams,
+  headers: new GetFileUploadSessionPartsHeaders({}),
+  cancellationToken: cancellationToken,
+} satisfies GetFileUploadSessionPartsOptionalsInput);
 ```
 
 ### Arguments
 
 - uploadSessionId `string`
   - The ID of the upload session. Example: "D5E3F7A"
-- queryParams `GetFileUploadSessionPartsQueryParams`
-  - Query parameters of getFileUploadSessionParts method
-- headersInput `GetFileUploadSessionPartsHeadersInput`
-  - Headers of getFileUploadSessionParts method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetFileUploadSessionPartsOptionalsInput`
+  -
 
 ### Returns
 
@@ -234,7 +222,9 @@ await this.createFileUploadSessionCommit(
   uploadSessionId,
   { parts: parts } satisfies CreateFileUploadSessionCommitRequestBody,
   { digest: digest } satisfies CreateFileUploadSessionCommitHeadersInput,
-  cancellationToken
+  {
+    cancellationToken: cancellationToken,
+  } satisfies CreateFileUploadSessionCommitOptionalsInput
 );
 ```
 
@@ -246,8 +236,8 @@ await this.createFileUploadSessionCommit(
   - Request body of createFileUploadSessionCommit method
 - headersInput `CreateFileUploadSessionCommitHeadersInput`
   - Headers of createFileUploadSessionCommit method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateFileUploadSessionCommitOptionalsInput`
+  -
 
 ### Returns
 

docs/classifications.md

@@ -76,10 +76,8 @@ await client.classifications.addClassification([
 
 - requestBody `readonly AddClassificationRequestBody[]`
   - Request body of addClassification method
-- headersInput `AddClassificationHeadersInput`
-  - Headers of addClassification method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `AddClassificationOptionalsInput`
+  -
 
 ### Returns
 
@@ -126,10 +124,8 @@ await client.classifications.updateClassification([
 
 - requestBody `readonly UpdateClassificationRequestBody[]`
   - Request body of updateClassification method
-- headersInput `UpdateClassificationHeadersInput`
-  - Headers of updateClassification method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `UpdateClassificationOptionalsInput`
+  -
 
 ### Returns
 
@@ -160,10 +156,8 @@ _Currently we don't have an example for calling `createClassificationTemplate` i
 
 - requestBodyInput `CreateClassificationTemplateRequestBodyInput`
   - Request body of createClassificationTemplate method
-- headersInput `CreateClassificationTemplateHeadersInput`
-  - Headers of createClassificationTemplate method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateClassificationTemplateOptionalsInput`
+  -
 
 ### Returns
 

docs/collaborationAllowlistEntries.md

@@ -59,10 +59,8 @@ await client.collaborationAllowlistEntries.createCollaborationWhitelistEntry({
 
 - requestBody `CreateCollaborationWhitelistEntryRequestBody`
   - Request body of createCollaborationWhitelistEntry method
-- headersInput `CreateCollaborationWhitelistEntryHeadersInput`
-  - Headers of createCollaborationWhitelistEntry method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateCollaborationWhitelistEntryOptionalsInput`
+  -
 
 ### Returns
 
@@ -92,10 +90,8 @@ await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById(
 
 - collaborationWhitelistEntryId `string`
   - The ID of the entry in the list. Example: "213123"
-- headersInput `GetCollaborationWhitelistEntryByIdHeadersInput`
-  - Headers of getCollaborationWhitelistEntryById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetCollaborationWhitelistEntryByIdOptionalsInput`
+  -
 
 ### Returns
 
@@ -125,10 +121,8 @@ await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById
 
 - collaborationWhitelistEntryId `string`
   - The ID of the entry in the list. Example: "213123"
-- headersInput `DeleteCollaborationWhitelistEntryByIdHeadersInput`
-  - Headers of deleteCollaborationWhitelistEntryById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `DeleteCollaborationWhitelistEntryByIdOptionalsInput`
+  -
 
 ### Returns
 

docs/collaborationAllowlistExemptTargets.md

@@ -62,10 +62,8 @@ await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExe
 
 - requestBody `CreateCollaborationWhitelistExemptTargetRequestBody`
   - Request body of createCollaborationWhitelistExemptTarget method
-- headersInput `CreateCollaborationWhitelistExemptTargetHeadersInput`
-  - Headers of createCollaborationWhitelistExemptTarget method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `CreateCollaborationWhitelistExemptTargetOptionalsInput`
+  -
 
 ### Returns
 
@@ -95,10 +93,8 @@ await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExempt
 
 - collaborationWhitelistExemptTargetId `string`
   - The ID of the exemption to the list. Example: "984923"
-- headersInput `GetCollaborationWhitelistExemptTargetByIdHeadersInput`
-  - Headers of getCollaborationWhitelistExemptTargetById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetCollaborationWhitelistExemptTargetByIdOptionalsInput`
+  -
 
 ### Returns
 
@@ -128,10 +124,8 @@ await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExe
 
 - collaborationWhitelistExemptTargetId `string`
   - The ID of the exemption to the list. Example: "984923"
-- headersInput `DeleteCollaborationWhitelistExemptTargetByIdHeadersInput`
-  - Headers of deleteCollaborationWhitelistExemptTargetById method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `DeleteCollaborationWhitelistExemptTargetByIdOptionalsInput`
+  -
 
 ### Returns
 

docs/collections.md

@@ -56,12 +56,8 @@ await client.collections.getCollectionItems(favouriteCollection.id!);
 
 - collectionId `string`
   - The ID of the collection. Example: "926489"
-- queryParams `GetCollectionItemsQueryParams`
-  - Query parameters of getCollectionItems method
-- headersInput `GetCollectionItemsHeadersInput`
-  - Headers of getCollectionItems method
-- cancellationToken `undefined | CancellationToken`
-  - Token used for request cancellation.
+- optionalsInput `GetCollectionItemsOptionalsInput`
+  -
 
 ### Returns