From c669f72ec1de379c9569d1f42196bd1a09b164cb Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Wed, 11 Feb 2026 02:12:01 -0800 Subject: [PATCH] feat: add signer language, cancel sign request reason (box/box-openapi#584) --- .codegen.json | 2 +- src/sdk-gen/managers/folders.ts | 12 +++---- src/sdk-gen/managers/signRequests.ts | 26 ++++++++++++-- .../schemas/aiExtractStructuredResponse.ts | 2 +- src/sdk-gen/schemas/index.ts | 1 + .../schemas/signRequestCancelRequest.ts | 36 +++++++++++++++++++ .../schemas/signRequestCreateSigner.ts | 14 ++++++++ src/sdk-gen/schemas/signRequestSigner.ts | 8 +++++ 8 files changed, 91 insertions(+), 10 deletions(-) create mode 100644 src/sdk-gen/schemas/signRequestCancelRequest.ts diff --git a/.codegen.json b/.codegen.json index 3924e07be..15546d47a 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "bfb97cc", "specHash": "ccdb456", "version": "4.3.0" } +{ "engineHash": "bfb97cc", "specHash": "77eac4b", "version": "4.3.0" } diff --git a/src/sdk-gen/managers/folders.ts b/src/sdk-gen/managers/folders.ts index 44d893bdb..7beda1bdd 100644 --- a/src/sdk-gen/managers/folders.ts +++ b/src/sdk-gen/managers/folders.ts @@ -293,9 +293,10 @@ export interface GetFolderByIdQueryParams { /** * The offset of the item at which to begin the response. * - * Queries with offset parameter value - * exceeding 10000 will be rejected - * with a 400 response. */ + * Offset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In + * those cases, reduce the number of items in the folder (for example, by + * restructuring the folder into smaller subfolders) before retrying the + * request. */ readonly offset?: number; /** * The maximum number of items to return per page. */ @@ -684,9 +685,8 @@ export interface GetFolderItemsQueryParams { /** * The offset of the item at which to begin the response. * - * Queries with offset parameter value - * exceeding 10000 will be rejected - * with a 400 response. */ + * Offset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In + * those cases, use marker-based pagination by setting `usemarker` to `true`. */ readonly offset?: number; /** * The maximum number of items to return per page. */ diff --git a/src/sdk-gen/managers/signRequests.ts b/src/sdk-gen/managers/signRequests.ts index e814a79c1..0def92acb 100644 --- a/src/sdk-gen/managers/signRequests.ts +++ b/src/sdk-gen/managers/signRequests.ts @@ -2,6 +2,8 @@ import { serializeSignRequest } from '../schemas/signRequest'; import { deserializeSignRequest } from '../schemas/signRequest'; import { serializeClientError } from '../schemas/clientError'; import { deserializeClientError } from '../schemas/clientError'; +import { serializeSignRequestCancelRequest } from '../schemas/signRequestCancelRequest'; +import { deserializeSignRequestCancelRequest } from '../schemas/signRequestCancelRequest'; import { serializeSignRequests } from '../schemas/signRequests'; import { deserializeSignRequests } from '../schemas/signRequests'; import { serializeSignRequestCreateRequest } from '../schemas/signRequestCreateRequest'; @@ -9,6 +11,7 @@ import { deserializeSignRequestCreateRequest } from '../schemas/signRequestCreat import { ResponseFormat } from '../networking/fetchOptions'; import { SignRequest } from '../schemas/signRequest'; import { ClientError } from '../schemas/clientError'; +import { SignRequestCancelRequest } from '../schemas/signRequestCancelRequest'; import { SignRequests } from '../schemas/signRequests'; import { SignRequestCreateRequest } from '../schemas/signRequestCreateRequest'; import { BoxSdkError } from '../box/errors'; @@ -29,12 +32,24 @@ import { sdIsString } from '../serialization/json'; import { sdIsList } from '../serialization/json'; import { sdIsMap } from '../serialization/json'; export class CancelSignRequestOptionals { + readonly requestBody?: SignRequestCancelRequest = void 0; readonly headers: CancelSignRequestHeaders = new CancelSignRequestHeaders({}); readonly cancellationToken?: CancellationToken = void 0; constructor( - fields: Omit & - Partial> + fields: Omit< + CancelSignRequestOptionals, + 'requestBody' | 'headers' | 'cancellationToken' + > & + Partial< + Pick< + CancelSignRequestOptionals, + 'requestBody' | 'headers' | 'cancellationToken' + > + > ) { + if (fields.requestBody !== undefined) { + this.requestBody = fields.requestBody; + } if (fields.headers !== undefined) { this.headers = fields.headers; } @@ -44,6 +59,7 @@ export class CancelSignRequestOptionals { } } export interface CancelSignRequestOptionalsInput { + readonly requestBody?: SignRequestCancelRequest; readonly headers?: CancelSignRequestHeaders; readonly cancellationToken?: CancellationToken; } @@ -274,9 +290,11 @@ export class SignRequestsManager { ): Promise { const optionals: CancelSignRequestOptionals = new CancelSignRequestOptionals({ + requestBody: optionalsInput.requestBody, headers: optionalsInput.headers, cancellationToken: optionalsInput.cancellationToken, }); + const requestBody: any = optionals.requestBody; const headers: any = optionals.headers; const cancellationToken: any = optionals.cancellationToken; const headersMap: { @@ -293,6 +311,10 @@ export class SignRequestsManager { ) as string, method: 'POST', headers: headersMap, + data: !(requestBody == void 0) + ? serializeSignRequestCancelRequest(requestBody) + : void 0, + contentType: 'application/json', responseFormat: 'json' as ResponseFormat, auth: this.auth, networkSession: this.networkSession, diff --git a/src/sdk-gen/schemas/aiExtractStructuredResponse.ts b/src/sdk-gen/schemas/aiExtractStructuredResponse.ts index b67736a2d..97b94ba6c 100644 --- a/src/sdk-gen/schemas/aiExtractStructuredResponse.ts +++ b/src/sdk-gen/schemas/aiExtractStructuredResponse.ts @@ -24,7 +24,7 @@ export interface AiExtractStructuredResponse { * The reason the response finishes. */ readonly completionReason?: string; /** - * The confidence score numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted. */ + * The confidence score levels and numeric values for each extracted field as a JSON dictionary. This can be empty if no field could be extracted. */ readonly confidenceScore?: { readonly [key: string]: any; }; diff --git a/src/sdk-gen/schemas/index.ts b/src/sdk-gen/schemas/index.ts index 7b1ba5c60..0783376c7 100644 --- a/src/sdk-gen/schemas/index.ts +++ b/src/sdk-gen/schemas/index.ts @@ -138,6 +138,7 @@ export * from './shieldInformationBarrierReportDetails'; export * from './shieldInformationBarrierSegmentMemberBase'; export * from './shieldInformationBarrierSegmentRestrictionBase'; export * from './shieldInformationBarrierSegmentRestrictionMini'; +export * from './signRequestCancelRequest'; export * from './signRequestCreateSigner'; export * from './signRequestPrefillTag'; export * from './signRequestBase'; diff --git a/src/sdk-gen/schemas/signRequestCancelRequest.ts b/src/sdk-gen/schemas/signRequestCancelRequest.ts new file mode 100644 index 000000000..57141f52c --- /dev/null +++ b/src/sdk-gen/schemas/signRequestCancelRequest.ts @@ -0,0 +1,36 @@ +import { BoxSdkError } from '../box/errors'; +import { SerializedData } from '../serialization/json'; +import { sdIsEmpty } from '../serialization/json'; +import { sdIsBoolean } from '../serialization/json'; +import { sdIsNumber } from '../serialization/json'; +import { sdIsString } from '../serialization/json'; +import { sdIsList } from '../serialization/json'; +import { sdIsMap } from '../serialization/json'; +export interface SignRequestCancelRequest { + /** + * An optional reason for cancelling the sign request. */ + readonly reason?: string; + readonly rawData?: SerializedData; +} +export function serializeSignRequestCancelRequest( + val: SignRequestCancelRequest +): SerializedData { + return { ['reason']: val.reason }; +} +export function deserializeSignRequestCancelRequest( + val: SerializedData +): SignRequestCancelRequest { + if (!sdIsMap(val)) { + throw new BoxSdkError({ + message: 'Expecting a map for "SignRequestCancelRequest"', + }); + } + if (!(val.reason == void 0) && !sdIsString(val.reason)) { + throw new BoxSdkError({ + message: + 'Expecting string for "reason" of type "SignRequestCancelRequest"', + }); + } + const reason: undefined | string = val.reason == void 0 ? void 0 : val.reason; + return { reason: reason } satisfies SignRequestCancelRequest; +} diff --git a/src/sdk-gen/schemas/signRequestCreateSigner.ts b/src/sdk-gen/schemas/signRequestCreateSigner.ts index 301fca650..becc30c43 100644 --- a/src/sdk-gen/schemas/signRequestCreateSigner.ts +++ b/src/sdk-gen/schemas/signRequestCreateSigner.ts @@ -74,6 +74,10 @@ export interface SignRequestCreateSigner { /** * If true, no emails about the sign request will be sent. */ readonly suppressNotifications?: boolean | null; + /** + * The language of the user, formatted in modified version of the + * [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format. */ + readonly language?: string | null; readonly rawData?: SerializedData; } export function serializeSignRequestCreateSignerRoleField( @@ -119,6 +123,7 @@ export function serializeSignRequestCreateSigner( ['password']: val.password, ['signer_group_id']: val.signerGroupId, ['suppress_notifications']: val.suppressNotifications, + ['language']: val.language, }; } export function deserializeSignRequestCreateSigner( @@ -233,6 +238,14 @@ export function deserializeSignRequestCreateSigner( } const suppressNotifications: undefined | boolean = val.suppress_notifications == void 0 ? void 0 : val.suppress_notifications; + if (!(val.language == void 0) && !sdIsString(val.language)) { + throw new BoxSdkError({ + message: + 'Expecting string for "language" of type "SignRequestCreateSigner"', + }); + } + const language: undefined | string = + val.language == void 0 ? void 0 : val.language; return { email: email, role: role, @@ -246,5 +259,6 @@ export function deserializeSignRequestCreateSigner( password: password, signerGroupId: signerGroupId, suppressNotifications: suppressNotifications, + language: language, } satisfies SignRequestCreateSigner; } diff --git a/src/sdk-gen/schemas/signRequestSigner.ts b/src/sdk-gen/schemas/signRequestSigner.ts index c4e0523ea..ac8f02f58 100644 --- a/src/sdk-gen/schemas/signRequestSigner.ts +++ b/src/sdk-gen/schemas/signRequestSigner.ts @@ -336,6 +336,13 @@ export function deserializeSignRequestSigner( } const suppressNotifications: undefined | boolean = val.suppress_notifications == void 0 ? void 0 : val.suppress_notifications; + if (!(val.language == void 0) && !sdIsString(val.language)) { + throw new BoxSdkError({ + message: 'Expecting string for "language" of type "SignRequestSigner"', + }); + } + const language: undefined | string = + val.language == void 0 ? void 0 : val.language; return { hasViewedDocument: hasViewedDocument, signerDecision: signerDecision, @@ -355,5 +362,6 @@ export function deserializeSignRequestSigner( password: password, signerGroupId: signerGroupId, suppressNotifications: suppressNotifications, + language: language, } satisfies SignRequestSigner; }