12547398862

Committed 30 Dec 2024 01:44PM UTC coverage: 43.462% (+0.06%) from 43.401%

Build # 12547398862

Build Type

push

github

Committed by

web-flow

Commit Message

feat: Support webhook message validation (box/box-codegen#631) (#455)

Co-authored-by: box-sdk-build <box-sdk-build@box.com>

Run Details

3928 of 15234 branches covered (25.78%)

Branch coverage included in aggregate %.

43 of 53 new or added lines in 2 files covered. (81.13%)

3697 existing lines in 76 files now uncovered.

13661 of 25236 relevant lines covered (54.13%)

83.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

53.85

/src/managers/folderLocks.generated.ts

import { serializeFolderLocks } from '../schemas/folderLocks.generated.js';
import { deserializeFolderLocks } from '../schemas/folderLocks.generated.js';
import { serializeClientError } from '../schemas/clientError.generated.js';
import { deserializeClientError } from '../schemas/clientError.generated.js';
import { serializeFolderLock } from '../schemas/folderLock.generated.js';
import { deserializeFolderLock } from '../schemas/folderLock.generated.js';
import { ResponseFormat } from '../networking/fetchOptions.generated.js';
import { FolderLocks } from '../schemas/folderLocks.generated.js';
import { ClientError } from '../schemas/clientError.generated.js';
import { FolderLock } from '../schemas/folderLock.generated.js';
import { BoxSdkError } from '../box/errors.js';
import { Authentication } from '../networking/auth.generated.js';
import { NetworkSession } from '../networking/network.generated.js';
import { FetchOptions } from '../networking/fetchOptions.generated.js';
import { FetchResponse } from '../networking/fetchResponse.generated.js';
import { prepareParams } from '../internal/utils.js';
import { toString } from '../internal/utils.js';
import { ByteStream } from '../internal/utils.js';
import { CancellationToken } from '../internal/utils.js';
import { sdToJson } from '../serialization/json.js';
import { SerializedData } from '../serialization/json.js';
import { sdIsEmpty } from '../serialization/json.js';
import { sdIsBoolean } from '../serialization/json.js';
import { sdIsNumber } from '../serialization/json.js';
import { sdIsString } from '../serialization/json.js';
import { sdIsList } from '../serialization/json.js';
import { sdIsMap } from '../serialization/json.js';
export class GetFolderLocksOptionals {
  readonly headers: GetFolderLocksHeaders = new GetFolderLocksHeaders({});
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<GetFolderLocksOptionals, 'headers' | 'cancellationToken'> &
      Partial<Pick<GetFolderLocksOptionals, 'headers' | 'cancellationToken'>>,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface GetFolderLocksOptionalsInput {
  readonly headers?: GetFolderLocksHeaders;
  readonly cancellationToken?: undefined | CancellationToken;
}
export class CreateFolderLockOptionals {
  readonly headers: CreateFolderLockHeaders = new CreateFolderLockHeaders({});
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<CreateFolderLockOptionals, 'headers' | 'cancellationToken'> &
      Partial<Pick<CreateFolderLockOptionals, 'headers' | 'cancellationToken'>>,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface CreateFolderLockOptionalsInput {
  readonly headers?: CreateFolderLockHeaders;
  readonly cancellationToken?: undefined | CancellationToken;
}
export class DeleteFolderLockByIdOptionals {
  readonly headers: DeleteFolderLockByIdHeaders =
    new DeleteFolderLockByIdHeaders({});
  readonly cancellationToken?: CancellationToken = void 0;
  constructor(
    fields: Omit<
      DeleteFolderLockByIdOptionals,
      'headers' | 'cancellationToken'
    > &
      Partial<
        Pick<DeleteFolderLockByIdOptionals, 'headers' | 'cancellationToken'>
      >,
  ) {
    if (fields.headers !== undefined) {
      this.headers = fields.headers;
    }
    if (fields.cancellationToken !== undefined) {
      this.cancellationToken = fields.cancellationToken;
    }
  }
}
export interface DeleteFolderLockByIdOptionalsInput {
  readonly headers?: DeleteFolderLockByIdHeaders;
  readonly cancellationToken?: undefined | CancellationToken;
}
export interface GetFolderLocksQueryParams {
  /**
   * The unique identifier that represent a folder.
   *
   * The ID for any folder can be determined
   * by visiting this folder in the web application
   * and copying the ID from the URL. For example,
   * for the URL `https://*.app.box.com/folder/123`
   * the `folder_id` is `123`.
   *
   * The root folder of a Box account is
   * always represented by the ID `0`. */
  readonly folderId: string;
}
export class GetFolderLocksHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<GetFolderLocksHeaders, 'extraHeaders'> &
      Partial<Pick<GetFolderLocksHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface GetFolderLocksHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?:
    | undefined
    | {
        readonly [key: string]: undefined | string;
      };
}
export interface CreateFolderLockRequestBodyLockedOperationsField {
  /**
   * Whether moving the folder should be locked. */
  readonly move: boolean;
  /**
   * Whether deleting the folder should be locked. */
  readonly delete: boolean;
  readonly rawData?: SerializedData;
}
export interface CreateFolderLockRequestBodyFolderField {
  /**
   * The content type the lock is being applied to. Only `folder`
   * is supported. */
  readonly type: string;
  /**
   * The ID of the folder. */
  readonly id: string;
  readonly rawData?: SerializedData;
}
export interface CreateFolderLockRequestBody {
  /**
   * The operations to lock for the folder. If `locked_operations` is
   * included in the request, both `move` and `delete` must also be
   * included and both set to `true`. */
  readonly lockedOperations?: CreateFolderLockRequestBodyLockedOperationsField;
  /**
   * The folder to apply the lock to. */
  readonly folder: CreateFolderLockRequestBodyFolderField;
  readonly rawData?: SerializedData;
}
export class CreateFolderLockHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<CreateFolderLockHeaders, 'extraHeaders'> &
      Partial<Pick<CreateFolderLockHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface CreateFolderLockHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?:
    | undefined
    | {
        readonly [key: string]: undefined | string;
      };
}
export class DeleteFolderLockByIdHeaders {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?: {
    readonly [key: string]: undefined | string;
  } = {};
  constructor(
    fields: Omit<DeleteFolderLockByIdHeaders, 'extraHeaders'> &
      Partial<Pick<DeleteFolderLockByIdHeaders, 'extraHeaders'>>,
  ) {
    if (fields.extraHeaders !== undefined) {
      this.extraHeaders = fields.extraHeaders;
    }
  }
}
export interface DeleteFolderLockByIdHeadersInput {
  /**
   * Extra headers that will be included in the HTTP request. */
  readonly extraHeaders?:
    | undefined
    | {
        readonly [key: string]: undefined | string;
      };
}
export class FolderLocksManager {
  readonly auth?: Authentication;
  readonly networkSession: NetworkSession = new NetworkSession({});
  constructor(
    fields: Omit<
      FolderLocksManager,
      | 'networkSession'
      | 'getFolderLocks'
      | 'createFolderLock'
      | 'deleteFolderLockById'
    > &
      Partial<Pick<FolderLocksManager, 'networkSession'>>,
  ) {
    if (fields.auth !== undefined) {
      this.auth = fields.auth;
    }
    if (fields.networkSession !== undefined) {
      this.networkSession = fields.networkSession;
    }
  }
  /**
   * Retrieves folder lock details for a given folder.
   *
   * You must be authenticated as the owner or co-owner of the folder to
   * use this endpoint.
   * @param {GetFolderLocksQueryParams} queryParams Query parameters of getFolderLocks method
   * @param {GetFolderLocksOptionalsInput} optionalsInput
   * @returns {Promise<FolderLocks>}
   */
  async getFolderLocks(
    queryParams: GetFolderLocksQueryParams,
    optionalsInput: GetFolderLocksOptionalsInput = {},
  ): Promise<FolderLocks> {
    const optionals: GetFolderLocksOptionals = new GetFolderLocksOptionals({
      headers: optionalsInput.headers,
      cancellationToken: optionalsInput.cancellationToken,
    });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const queryParamsMap: {
      readonly [key: string]: string;
    } = prepareParams({
      ['folder_id']: toString(queryParams.folderId) as string,
    });
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/folder_locks',
          ) as string,
          method: 'GET',
          params: queryParamsMap,
          headers: headersMap,
          responseFormat: 'json' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return {
      ...deserializeFolderLocks(response.data!),
      rawData: response.data!,
    };
  }
  /**
   * Creates a folder lock on a folder, preventing it from being moved and/or
   * deleted.
   *
   * You must be authenticated as the owner or co-owner of the folder to
   * use this endpoint.
   * @param {CreateFolderLockRequestBody} requestBody Request body of createFolderLock method
   * @param {CreateFolderLockOptionalsInput} optionalsInput
   * @returns {Promise<FolderLock>}
   */
  async createFolderLock(
    requestBody: CreateFolderLockRequestBody,
    optionalsInput: CreateFolderLockOptionalsInput = {},
  ): Promise<FolderLock> {
    const optionals: CreateFolderLockOptionals = new CreateFolderLockOptionals({
      headers: optionalsInput.headers,
      cancellationToken: optionalsInput.cancellationToken,
    });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/folder_locks',
          ) as string,
          method: 'POST',
          headers: headersMap,
          data: serializeCreateFolderLockRequestBody(requestBody),
          contentType: 'application/json',
          responseFormat: 'json' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return {
      ...deserializeFolderLock(response.data!),
      rawData: response.data!,
    };
  }
  /**
     * Deletes a folder lock on a given folder.
     *
     * You must be authenticated as the owner or co-owner of the folder to
     * use this endpoint.
     * @param {string} folderLockId The ID of the folder lock.
    Example: "12345"
     * @param {DeleteFolderLockByIdOptionalsInput} optionalsInput
     * @returns {Promise<undefined>}
     */
  async deleteFolderLockById(
    folderLockId: string,
    optionalsInput: DeleteFolderLockByIdOptionalsInput = {},
  ): Promise<undefined> {
    const optionals: DeleteFolderLockByIdOptionals =
      new DeleteFolderLockByIdOptionals({
        headers: optionalsInput.headers,
        cancellationToken: optionalsInput.cancellationToken,
      });
    const headers: any = optionals.headers;
    const cancellationToken: any = optionals.cancellationToken;
    const headersMap: {
      readonly [key: string]: string;
    } = prepareParams({ ...{}, ...headers.extraHeaders });
    const response: FetchResponse =
      await this.networkSession.networkClient.fetch(
        new FetchOptions({
          url: ''.concat(
            this.networkSession.baseUrls.baseUrl,
            '/2.0/folder_locks/',
            toString(folderLockId) as string,
          ) as string,
          method: 'DELETE',
          headers: headersMap,
          responseFormat: 'no_content' as ResponseFormat,
          auth: this.auth,
          networkSession: this.networkSession,
          cancellationToken: cancellationToken,
        }),
      );
    return void 0;
  }
}
export interface FolderLocksManagerInput {
  readonly auth?: Authentication;
  readonly networkSession?: NetworkSession;
}
export function serializeCreateFolderLockRequestBodyLockedOperationsField(
  val: CreateFolderLockRequestBodyLockedOperationsField,
): SerializedData {
  return { ['move']: val.move, ['delete']: val.delete };
}
export function deserializeCreateFolderLockRequestBodyLockedOperationsField(
  val: SerializedData,
): CreateFolderLockRequestBodyLockedOperationsField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message:
        'Expecting a map for "CreateFolderLockRequestBodyLockedOperationsField"',
    });
  }
  if (val.move == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "move" of type "CreateFolderLockRequestBodyLockedOperationsField" to be defined',
    });
  }
  if (!sdIsBoolean(val.move)) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "move" of type "CreateFolderLockRequestBodyLockedOperationsField"',
    });
  }
  const move: boolean = val.move;
  if (val.delete == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "delete" of type "CreateFolderLockRequestBodyLockedOperationsField" to be defined',
    });
  }
  if (!sdIsBoolean(val.delete)) {
    throw new BoxSdkError({
      message:
        'Expecting boolean for "delete" of type "CreateFolderLockRequestBodyLockedOperationsField"',
    });
  }
  const _delete: boolean = val.delete;
  return {
    move: move,
    delete: _delete,
  } satisfies CreateFolderLockRequestBodyLockedOperationsField;
}
export function serializeCreateFolderLockRequestBodyFolderField(
  val: CreateFolderLockRequestBodyFolderField,
): SerializedData {
  return { ['type']: val.type, ['id']: val.id };
}
export function deserializeCreateFolderLockRequestBodyFolderField(
  val: SerializedData,
): CreateFolderLockRequestBodyFolderField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "CreateFolderLockRequestBodyFolderField"',
    });
  }
  if (val.type == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "type" of type "CreateFolderLockRequestBodyFolderField" to be defined',
    });
  }
  if (!sdIsString(val.type)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "type" of type "CreateFolderLockRequestBodyFolderField"',
    });
  }
  const type: string = val.type;
  if (val.id == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "id" of type "CreateFolderLockRequestBodyFolderField" to be defined',
    });
  }
  if (!sdIsString(val.id)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "id" of type "CreateFolderLockRequestBodyFolderField"',
    });
  }
  const id: string = val.id;
  return {
    type: type,
    id: id,
  } satisfies CreateFolderLockRequestBodyFolderField;
}
export function serializeCreateFolderLockRequestBody(
  val: CreateFolderLockRequestBody,
): SerializedData {
  return {
    ['locked_operations']:
      val.lockedOperations == void 0
        ? val.lockedOperations
        : serializeCreateFolderLockRequestBodyLockedOperationsField(
            val.lockedOperations,
          ),
    ['folder']: serializeCreateFolderLockRequestBodyFolderField(val.folder),
  };
}
export function deserializeCreateFolderLockRequestBody(
  val: SerializedData,
): CreateFolderLockRequestBody {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "CreateFolderLockRequestBody"',
    });
  }
  const lockedOperations:
    | undefined
    | CreateFolderLockRequestBodyLockedOperationsField =
    val.locked_operations == void 0
      ? void 0
      : deserializeCreateFolderLockRequestBodyLockedOperationsField(
          val.locked_operations,
        );
  if (val.folder == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "folder" of type "CreateFolderLockRequestBody" to be defined',
    });
  }
  const folder: CreateFolderLockRequestBodyFolderField =
    deserializeCreateFolderLockRequestBodyFolderField(val.folder);
  return {
    lockedOperations: lockedOperations,
    folder: folder,
  } satisfies CreateFolderLockRequestBody;
}

1	import { serializeFolderLocks } from '../schemas/folderLocks.generated.js';
2	import { deserializeFolderLocks } from '../schemas/folderLocks.generated.js';	140✔
3	import { serializeClientError } from '../schemas/clientError.generated.js';
4	import { deserializeClientError } from '../schemas/clientError.generated.js';
5	import { serializeFolderLock } from '../schemas/folderLock.generated.js';
6	import { deserializeFolderLock } from '../schemas/folderLock.generated.js';	140✔
7	import { ResponseFormat } from '../networking/fetchOptions.generated.js';
8	import { FolderLocks } from '../schemas/folderLocks.generated.js';
9	import { ClientError } from '../schemas/clientError.generated.js';
10	import { FolderLock } from '../schemas/folderLock.generated.js';
11	import { BoxSdkError } from '../box/errors.js';	140✔
12	import { Authentication } from '../networking/auth.generated.js';
13	import { NetworkSession } from '../networking/network.generated.js';	140✔
14	import { FetchOptions } from '../networking/fetchOptions.generated.js';	140✔
15	import { FetchResponse } from '../networking/fetchResponse.generated.js';
16	import { prepareParams } from '../internal/utils.js';	140✔
17	import { toString } from '../internal/utils.js';	140✔
18	import { ByteStream } from '../internal/utils.js';
19	import { CancellationToken } from '../internal/utils.js';
20	import { sdToJson } from '../serialization/json.js';
21	import { SerializedData } from '../serialization/json.js';
22	import { sdIsEmpty } from '../serialization/json.js';
23	import { sdIsBoolean } from '../serialization/json.js';	140✔
24	import { sdIsNumber } from '../serialization/json.js';
25	import { sdIsString } from '../serialization/json.js';	140✔
26	import { sdIsList } from '../serialization/json.js';
27	import { sdIsMap } from '../serialization/json.js';	140✔
28	export class GetFolderLocksOptionals {	140✔
29	readonly headers: GetFolderLocksHeaders = new GetFolderLocksHeaders({});	4✔
30	readonly cancellationToken?: CancellationToken = void 0;	4✔
31	constructor(
32	fields: Omit<GetFolderLocksOptionals, 'headers' \| 'cancellationToken'> &
33	Partial<Pick<GetFolderLocksOptionals, 'headers' \| 'cancellationToken'>>,
34	) {
35	if (fields.headers !== undefined) {	4!
UNCOV 36	this.headers = fields.headers;	×
37	}
38	if (fields.cancellationToken !== undefined) {	4!
UNCOV 39	this.cancellationToken = fields.cancellationToken;	×
40	}
41	}
42	}
43	export interface GetFolderLocksOptionalsInput {
44	readonly headers?: GetFolderLocksHeaders;
45	readonly cancellationToken?: undefined \| CancellationToken;
46	}
47	export class CreateFolderLockOptionals {	140✔
48	readonly headers: CreateFolderLockHeaders = new CreateFolderLockHeaders({});	2✔
49	readonly cancellationToken?: CancellationToken = void 0;	2✔
50	constructor(
51	fields: Omit<CreateFolderLockOptionals, 'headers' \| 'cancellationToken'> &
52	Partial<Pick<CreateFolderLockOptionals, 'headers' \| 'cancellationToken'>>,
53	) {
54	if (fields.headers !== undefined) {	2!
UNCOV 55	this.headers = fields.headers;	×
56	}
57	if (fields.cancellationToken !== undefined) {	2!
UNCOV 58	this.cancellationToken = fields.cancellationToken;	×
59	}
60	}
61	}
62	export interface CreateFolderLockOptionalsInput {
63	readonly headers?: CreateFolderLockHeaders;
64	readonly cancellationToken?: undefined \| CancellationToken;
65	}
66	export class DeleteFolderLockByIdOptionals {	140✔
67	readonly headers: DeleteFolderLockByIdHeaders =	4✔
68	new DeleteFolderLockByIdHeaders({});
69	readonly cancellationToken?: CancellationToken = void 0;	4✔
70	constructor(
71	fields: Omit<
72	DeleteFolderLockByIdOptionals,
73	'headers' \| 'cancellationToken'
74	> &
75	Partial<
76	Pick<DeleteFolderLockByIdOptionals, 'headers' \| 'cancellationToken'>
77	>,
78	) {
79	if (fields.headers !== undefined) {	4!
UNCOV 80	this.headers = fields.headers;	×
81	}
82	if (fields.cancellationToken !== undefined) {	4!
UNCOV 83	this.cancellationToken = fields.cancellationToken;	×
84	}
85	}
86	}
87	export interface DeleteFolderLockByIdOptionalsInput {
88	readonly headers?: DeleteFolderLockByIdHeaders;
89	readonly cancellationToken?: undefined \| CancellationToken;
90	}
91	export interface GetFolderLocksQueryParams {
92	/**
93	* The unique identifier that represent a folder.
94	*
95	* The ID for any folder can be determined
96	* by visiting this folder in the web application
97	* and copying the ID from the URL. For example,
98	* for the URL `https://*.app.box.com/folder/123`
99	* the `folder_id` is `123`.
100	*
101	* The root folder of a Box account is
102	* always represented by the ID `0`. */
103	readonly folderId: string;
104	}
105	export class GetFolderLocksHeaders {	140✔
106	/**
107	* Extra headers that will be included in the HTTP request. */
108	readonly extraHeaders?: {	4✔
109	readonly [key: string]: undefined \| string;
110	} = {};
111	constructor(
112	fields: Omit<GetFolderLocksHeaders, 'extraHeaders'> &
113	Partial<Pick<GetFolderLocksHeaders, 'extraHeaders'>>,
114	) {
115	if (fields.extraHeaders !== undefined) {	4!
UNCOV 116	this.extraHeaders = fields.extraHeaders;	×
117	}
118	}
119	}
120	export interface GetFolderLocksHeadersInput {
121	/**
122	* Extra headers that will be included in the HTTP request. */
123	readonly extraHeaders?:
124	\| undefined
125	\| {
126	readonly [key: string]: undefined \| string;
127	};
128	}
129	export interface CreateFolderLockRequestBodyLockedOperationsField {
130	/**
131	* Whether moving the folder should be locked. */
132	readonly move: boolean;
133	/**
134	* Whether deleting the folder should be locked. */
135	readonly delete: boolean;
136	readonly rawData?: SerializedData;
137	}
138	export interface CreateFolderLockRequestBodyFolderField {
139	/**
140	* The content type the lock is being applied to. Only `folder`
141	* is supported. */
142	readonly type: string;
143	/**
144	* The ID of the folder. */
145	readonly id: string;
146	readonly rawData?: SerializedData;
147	}
148	export interface CreateFolderLockRequestBody {
149	/**
150	* The operations to lock for the folder. If `locked_operations` is
151	* included in the request, both `move` and `delete` must also be
152	* included and both set to `true`. */
153	readonly lockedOperations?: CreateFolderLockRequestBodyLockedOperationsField;
154	/**
155	* The folder to apply the lock to. */
156	readonly folder: CreateFolderLockRequestBodyFolderField;
157	readonly rawData?: SerializedData;
158	}
159	export class CreateFolderLockHeaders {	140✔
160	/**
161	* Extra headers that will be included in the HTTP request. */
162	readonly extraHeaders?: {	2✔
163	readonly [key: string]: undefined \| string;
164	} = {};
165	constructor(
166	fields: Omit<CreateFolderLockHeaders, 'extraHeaders'> &
167	Partial<Pick<CreateFolderLockHeaders, 'extraHeaders'>>,
168	) {
169	if (fields.extraHeaders !== undefined) {	2!
UNCOV 170	this.extraHeaders = fields.extraHeaders;	×
171	}
172	}
173	}
174	export interface CreateFolderLockHeadersInput {
175	/**
176	* Extra headers that will be included in the HTTP request. */
177	readonly extraHeaders?:
178	\| undefined
179	\| {
180	readonly [key: string]: undefined \| string;
181	};
182	}
183	export class DeleteFolderLockByIdHeaders {	140✔
184	/**
185	* Extra headers that will be included in the HTTP request. */
186	readonly extraHeaders?: {	4✔
187	readonly [key: string]: undefined \| string;
188	} = {};
189	constructor(
190	fields: Omit<DeleteFolderLockByIdHeaders, 'extraHeaders'> &
191	Partial<Pick<DeleteFolderLockByIdHeaders, 'extraHeaders'>>,
192	) {
193	if (fields.extraHeaders !== undefined) {	4!
UNCOV 194	this.extraHeaders = fields.extraHeaders;	×
195	}
196	}
197	}
198	export interface DeleteFolderLockByIdHeadersInput {
199	/**
200	* Extra headers that will be included in the HTTP request. */
201	readonly extraHeaders?:
202	\| undefined
203	\| {
204	readonly [key: string]: undefined \| string;
205	};
206	}
207	export class FolderLocksManager {	140✔
208	readonly auth?: Authentication;
209	readonly networkSession: NetworkSession = new NetworkSession({});	302✔
210	constructor(
211	fields: Omit<
212	FolderLocksManager,
213	\| 'networkSession'
214	\| 'getFolderLocks'
215	\| 'createFolderLock'
216	\| 'deleteFolderLockById'
217	> &
218	Partial<Pick<FolderLocksManager, 'networkSession'>>,
219	) {
220	if (fields.auth !== undefined) {	302✔
221	this.auth = fields.auth;	302✔
222	}
223	if (fields.networkSession !== undefined) {	302✔
224	this.networkSession = fields.networkSession;	302✔
225	}
226	}
227	/**
228	* Retrieves folder lock details for a given folder.
229	*
230	* You must be authenticated as the owner or co-owner of the folder to
231	* use this endpoint.
232	* @param {GetFolderLocksQueryParams} queryParams Query parameters of getFolderLocks method
233	* @param {GetFolderLocksOptionalsInput} optionalsInput
234	* @returns {Promise<FolderLocks>}
235	*/
236	async getFolderLocks(
237	queryParams: GetFolderLocksQueryParams,	4✔
238	optionalsInput: GetFolderLocksOptionalsInput = {},	4✔
239	): Promise<FolderLocks> {
240	const optionals: GetFolderLocksOptionals = new GetFolderLocksOptionals({	4✔
241	headers: optionalsInput.headers,
242	cancellationToken: optionalsInput.cancellationToken,
243	});
244	const headers: any = optionals.headers;	4✔
245	const cancellationToken: any = optionals.cancellationToken;	4✔
246	const queryParamsMap: {
247	readonly [key: string]: string;
248	} = prepareParams({	4✔
249	['folder_id']: toString(queryParams.folderId) as string,
250	});
251	const headersMap: {
252	readonly [key: string]: string;
253	} = prepareParams({ ...{}, ...headers.extraHeaders });	4✔
254	const response: FetchResponse =
255	await this.networkSession.networkClient.fetch(	4✔
256	new FetchOptions({
257	url: ''.concat(
258	this.networkSession.baseUrls.baseUrl,
259	'/2.0/folder_locks',
260	) as string,
261	method: 'GET',
262	params: queryParamsMap,
263	headers: headersMap,
264	responseFormat: 'json' as ResponseFormat,
265	auth: this.auth,
266	networkSession: this.networkSession,
267	cancellationToken: cancellationToken,
268	}),
269	);
270	return {	4✔
271	...deserializeFolderLocks(response.data!),
272	rawData: response.data!,
273	};
274	}
275	/**
276	* Creates a folder lock on a folder, preventing it from being moved and/or
277	* deleted.
278	*
279	* You must be authenticated as the owner or co-owner of the folder to
280	* use this endpoint.
281	* @param {CreateFolderLockRequestBody} requestBody Request body of createFolderLock method
282	* @param {CreateFolderLockOptionalsInput} optionalsInput
283	* @returns {Promise<FolderLock>}
284	*/
285	async createFolderLock(
286	requestBody: CreateFolderLockRequestBody,	2✔
287	optionalsInput: CreateFolderLockOptionalsInput = {},	2✔
288	): Promise<FolderLock> {
289	const optionals: CreateFolderLockOptionals = new CreateFolderLockOptionals({	2✔
290	headers: optionalsInput.headers,
291	cancellationToken: optionalsInput.cancellationToken,
292	});
293	const headers: any = optionals.headers;	2✔
294	const cancellationToken: any = optionals.cancellationToken;	2✔
295	const headersMap: {
296	readonly [key: string]: string;
297	} = prepareParams({ ...{}, ...headers.extraHeaders });	2✔
298	const response: FetchResponse =
299	await this.networkSession.networkClient.fetch(	2✔
300	new FetchOptions({
301	url: ''.concat(
302	this.networkSession.baseUrls.baseUrl,
303	'/2.0/folder_locks',
304	) as string,
305	method: 'POST',
306	headers: headersMap,
307	data: serializeCreateFolderLockRequestBody(requestBody),
308	contentType: 'application/json',
309	responseFormat: 'json' as ResponseFormat,
310	auth: this.auth,
311	networkSession: this.networkSession,
312	cancellationToken: cancellationToken,
313	}),
314	);
315	return {	2✔
316	...deserializeFolderLock(response.data!),
317	rawData: response.data!,
318	};
319	}
320	/**
321	* Deletes a folder lock on a given folder.
322	*
323	* You must be authenticated as the owner or co-owner of the folder to
324	* use this endpoint.
325	* @param {string} folderLockId The ID of the folder lock.
326	Example: "12345"
327	* @param {DeleteFolderLockByIdOptionalsInput} optionalsInput
328	* @returns {Promise<undefined>}
329	*/
330	async deleteFolderLockById(
331	folderLockId: string,	4✔
332	optionalsInput: DeleteFolderLockByIdOptionalsInput = {},	4✔
333	): Promise<undefined> {
334	const optionals: DeleteFolderLockByIdOptionals =
335	new DeleteFolderLockByIdOptionals({	4✔
336	headers: optionalsInput.headers,
337	cancellationToken: optionalsInput.cancellationToken,
338	});
339	const headers: any = optionals.headers;	4✔
340	const cancellationToken: any = optionals.cancellationToken;	4✔
341	const headersMap: {
342	readonly [key: string]: string;
343	} = prepareParams({ ...{}, ...headers.extraHeaders });	4✔
344	const response: FetchResponse =
345	await this.networkSession.networkClient.fetch(	4✔
346	new FetchOptions({
347	url: ''.concat(
348	this.networkSession.baseUrls.baseUrl,
349	'/2.0/folder_locks/',
350	toString(folderLockId) as string,
351	) as string,
352	method: 'DELETE',
353	headers: headersMap,
354	responseFormat: 'no_content' as ResponseFormat,
355	auth: this.auth,
356	networkSession: this.networkSession,
357	cancellationToken: cancellationToken,
358	}),
359	);
360	return void 0;	2✔
361	}
362	}
363	export interface FolderLocksManagerInput {
364	readonly auth?: Authentication;
365	readonly networkSession?: NetworkSession;
366	}
367	export function serializeCreateFolderLockRequestBodyLockedOperationsField(	140✔
368	val: CreateFolderLockRequestBodyLockedOperationsField,
369	): SerializedData {
370	return { ['move']: val.move, ['delete']: val.delete };	2✔
371	}
372	export function deserializeCreateFolderLockRequestBodyLockedOperationsField(	140✔
373	val: SerializedData,
374	): CreateFolderLockRequestBodyLockedOperationsField {
UNCOV 375	if (!sdIsMap(val)) {	×
UNCOV 376	throw new BoxSdkError({	×
377	message:
378	'Expecting a map for "CreateFolderLockRequestBodyLockedOperationsField"',
379	});
380	}
UNCOV 381	if (val.move == void 0) {	×
UNCOV 382	throw new BoxSdkError({	×
383	message:
384	'Expecting "move" of type "CreateFolderLockRequestBodyLockedOperationsField" to be defined',
385	});
386	}
UNCOV 387	if (!sdIsBoolean(val.move)) {	×
UNCOV 388	throw new BoxSdkError({	×
389	message:
390	'Expecting boolean for "move" of type "CreateFolderLockRequestBodyLockedOperationsField"',
391	});
392	}
393	const move: boolean = val.move;	×
UNCOV 394	if (val.delete == void 0) {	×
UNCOV 395	throw new BoxSdkError({	×
396	message:
397	'Expecting "delete" of type "CreateFolderLockRequestBodyLockedOperationsField" to be defined',
398	});
399	}
UNCOV 400	if (!sdIsBoolean(val.delete)) {	×
UNCOV 401	throw new BoxSdkError({	×
402	message:
403	'Expecting boolean for "delete" of type "CreateFolderLockRequestBodyLockedOperationsField"',
404	});
405	}
UNCOV 406	const _delete: boolean = val.delete;	×
UNCOV 407	return {	×
408	move: move,
409	delete: _delete,
410	} satisfies CreateFolderLockRequestBodyLockedOperationsField;
411	}
412	export function serializeCreateFolderLockRequestBodyFolderField(	140✔
413	val: CreateFolderLockRequestBodyFolderField,
414	): SerializedData {
415	return { ['type']: val.type, ['id']: val.id };	2✔
416	}
417	export function deserializeCreateFolderLockRequestBodyFolderField(	140✔
418	val: SerializedData,
419	): CreateFolderLockRequestBodyFolderField {
UNCOV 420	if (!sdIsMap(val)) {	×
UNCOV 421	throw new BoxSdkError({	×
422	message: 'Expecting a map for "CreateFolderLockRequestBodyFolderField"',
423	});
424	}
UNCOV 425	if (val.type == void 0) {	×
UNCOV 426	throw new BoxSdkError({	×
427	message:
428	'Expecting "type" of type "CreateFolderLockRequestBodyFolderField" to be defined',
429	});
430	}
UNCOV 431	if (!sdIsString(val.type)) {	×
UNCOV 432	throw new BoxSdkError({	×
433	message:
434	'Expecting string for "type" of type "CreateFolderLockRequestBodyFolderField"',
435	});
436	}
437	const type: string = val.type;	×
UNCOV 438	if (val.id == void 0) {	×
UNCOV 439	throw new BoxSdkError({	×
440	message:
441	'Expecting "id" of type "CreateFolderLockRequestBodyFolderField" to be defined',
442	});
443	}
UNCOV 444	if (!sdIsString(val.id)) {	×
UNCOV 445	throw new BoxSdkError({	×
446	message:
447	'Expecting string for "id" of type "CreateFolderLockRequestBodyFolderField"',
448	});
449	}
UNCOV 450	const id: string = val.id;	×
UNCOV 451	return {	×
452	type: type,
453	id: id,
454	} satisfies CreateFolderLockRequestBodyFolderField;
455	}
456	export function serializeCreateFolderLockRequestBody(	140✔
457	val: CreateFolderLockRequestBody,
458	): SerializedData {
459	return {	2✔
460	['locked_operations']:
461	val.lockedOperations == void 0	2!
462	? val.lockedOperations
463	: serializeCreateFolderLockRequestBodyLockedOperationsField(
464	val.lockedOperations,
465	),
466	['folder']: serializeCreateFolderLockRequestBodyFolderField(val.folder),
467	};
468	}
469	export function deserializeCreateFolderLockRequestBody(	140✔
470	val: SerializedData,
471	): CreateFolderLockRequestBody {
UNCOV 472	if (!sdIsMap(val)) {	×
UNCOV 473	throw new BoxSdkError({	×
474	message: 'Expecting a map for "CreateFolderLockRequestBody"',
475	});
476	}
477	const lockedOperations:
478	\| undefined
479	\| CreateFolderLockRequestBodyLockedOperationsField =
UNCOV 480	val.locked_operations == void 0	×
481	? void 0
482	: deserializeCreateFolderLockRequestBodyLockedOperationsField(
483	val.locked_operations,
484	);
UNCOV 485	if (val.folder == void 0) {	×
UNCOV 486	throw new BoxSdkError({	×
487	message:
488	'Expecting "folder" of type "CreateFolderLockRequestBody" to be defined',
489	});
490	}
491	const folder: CreateFolderLockRequestBodyFolderField =
UNCOV 492	deserializeCreateFolderLockRequestBodyFolderField(val.folder);	×
UNCOV 493	return {	×
494	lockedOperations: lockedOperations,
495	folder: folder,
496	} satisfies CreateFolderLockRequestBody;
497	}

box / box-typescript-sdk-gen / 12547398862

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous