From 2bc5867319b952fe1d77fe30a5bed7b1abcdf109 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Thu, 23 Jan 2025 03:39:54 -0800 Subject: [PATCH] feat: add Box Sign shared requests (box/box-openapi#504) --- .codegen.json | 2 +- package-lock.json | 12 ++++---- src/managers/signRequests.generated.ts | 14 +++++++++ src/schemas/signRequest.generated.ts | 40 ++++++++++++++++++++++++++ 4 files changed, 61 insertions(+), 7 deletions(-) diff --git a/.codegen.json b/.codegen.json index 4d22e80b..a04c7d31 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1 +1 @@ -{ "engineHash": "b5ed925", "specHash": "99792c6", "version": "1.11.0" } +{ "engineHash": "b5ed925", "specHash": "3dc3f1e", "version": "1.11.0" } diff --git a/package-lock.json b/package-lock.json index 8cf6babd..6af03aab 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1379,9 +1379,9 @@ } }, "node_modules/@types/node": { - "version": "22.10.7", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.7.tgz", - "integrity": "sha512-V09KvXxFiutGp6B7XkpaDXlNadZxrzajcY50EuoLIpQ6WWYCSvf19lVIazzfIzQvhUN2HjX12spLojTnhuKlGg==", + "version": "22.10.9", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.9.tgz", + "integrity": "sha512-Ir6hwgsKyNESl/gLOcEz3krR4CBGgliDqBQ2ma4wIhEx0w+xnoeTq3tdrNw15kU3SxogDjOgv9sqdtLW8mIHaw==", "dev": true, "dependencies": { "undici-types": "~6.20.0" @@ -2091,9 +2091,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.84", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.84.tgz", - "integrity": "sha512-I+DQ8xgafao9Ha6y0qjHHvpZ9OfyA1qKlkHkjywxzniORU2awxyz7f/iVJcULmrF2yrM3nHQf+iDjJtbbexd/g==", + "version": "1.5.86", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.86.tgz", + "integrity": "sha512-/D7GAAaCRBQFBBcop6SfAAGH37djtpWkOuYhyAajw0l5vsfeSsUQYxaFPwr1c/mC/flARCDdKFo5gpFqNI+18w==", "dev": true }, "node_modules/emittery": { diff --git a/src/managers/signRequests.generated.ts b/src/managers/signRequests.generated.ts index 7f9db088..91a74da1 100644 --- a/src/managers/signRequests.generated.ts +++ b/src/managers/signRequests.generated.ts @@ -196,6 +196,16 @@ export interface GetSignRequestsQueryParams { /** * The maximum number of items to return per page. */ readonly limit?: number; + /** + * A list of sender emails to filter the signature requests by sender. + * If provided, `shared_requests` must be set to `true`. */ + readonly senders?: readonly string[]; + /** + * If set to `true`, only includes requests that user is not an owner, + * but user is a collaborator. Collaborator access is determined by the + * user access level of the sign files of the request. + * Default is `false`. Must be set to `true` if `senders` are provided. */ + readonly sharedRequests?: boolean; } export class GetSignRequestsHeaders { /** @@ -413,6 +423,10 @@ export class SignRequestsManager { } = prepareParams({ ['marker']: toString(queryParams.marker) as string, ['limit']: toString(queryParams.limit) as string, + ['senders']: queryParams.senders + ? queryParams.senders.map(toString).join(',') + : undefined, + ['shared_requests']: toString(queryParams.sharedRequests) as string, }); const headersMap: { readonly [key: string]: string; diff --git a/src/schemas/signRequest.generated.ts b/src/schemas/signRequest.generated.ts index dbb405c9..f64c57bf 100644 --- a/src/schemas/signRequest.generated.ts +++ b/src/schemas/signRequest.generated.ts @@ -90,6 +90,15 @@ export type SignRequest = SignRequestBase & { * Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned. */ readonly autoExpireAt?: DateTime | null; readonly parentFolder?: FolderMini; + /** + * The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer" */ + readonly collaboratorLevel?: string | null; + /** + * The email address of the sender of the sign request. */ + readonly senderEmail?: string | null; + /** + * The user ID of the sender of the sign request. */ + readonly senderId?: number | null; }; export function serializeSignRequestTypeField( val: SignRequestTypeField, @@ -253,6 +262,9 @@ export function serializeSignRequest(val: SignRequest): SerializedData { val.parentFolder == void 0 ? val.parentFolder : serializeFolderMini(val.parentFolder), + ['collaborator_level']: val.collaboratorLevel, + ['sender_email']: val.senderEmail, + ['sender_id']: val.senderId, }, }; } @@ -331,6 +343,31 @@ export function deserializeSignRequest(val: SerializedData): SignRequest { val.parent_folder == void 0 ? void 0 : deserializeFolderMini(val.parent_folder); + if ( + !(val.collaborator_level == void 0) && + !sdIsString(val.collaborator_level) + ) { + throw new BoxSdkError({ + message: + 'Expecting string for "collaborator_level" of type "SignRequest"', + }); + } + const collaboratorLevel: undefined | string = + val.collaborator_level == void 0 ? void 0 : val.collaborator_level; + if (!(val.sender_email == void 0) && !sdIsString(val.sender_email)) { + throw new BoxSdkError({ + message: 'Expecting string for "sender_email" of type "SignRequest"', + }); + } + const senderEmail: undefined | string = + val.sender_email == void 0 ? void 0 : val.sender_email; + if (!(val.sender_id == void 0) && !sdIsNumber(val.sender_id)) { + throw new BoxSdkError({ + message: 'Expecting number for "sender_id" of type "SignRequest"', + }); + } + const senderId: undefined | number = + val.sender_id == void 0 ? void 0 : val.sender_id; if ( !(val.is_document_preparation_needed == void 0) && !sdIsBoolean(val.is_document_preparation_needed) @@ -465,6 +502,9 @@ export function deserializeSignRequest(val: SerializedData): SignRequest { signFiles: signFiles, autoExpireAt: autoExpireAt, parentFolder: parentFolder, + collaboratorLevel: collaboratorLevel, + senderEmail: senderEmail, + senderId: senderId, isDocumentPreparationNeeded: isDocumentPreparationNeeded, redirectUrl: redirectUrl, declinedRedirectUrl: declinedRedirectUrl,