feat: support excluding endpoints and schemas in parser (box/box-codegen#487) (#183)

Co-authored-by: Minh Nguyen Cong <[email protected]>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "2fccaa2", "specHash": "d5769a1", "version": "0.5.4" }
+{ "engineHash": "5012b13", "specHash": "d5769a1", "version": "0.5.4" }

docs/legalHoldPolicyAssignments.md

@@ -5,7 +5,6 @@
 - [Get legal hold policy assignment](#get-legal-hold-policy-assignment)
 - [Unassign legal hold policy](#unassign-legal-hold-policy)
 - [List current file versions for legal hold policy assignment](#list-current-file-versions-for-legal-hold-policy-assignment)
-- [List previous file versions for legal hold policy assignment](#list-previous-file-versions-for-legal-hold-policy-assignment)
 
 ## List legal hold policy assignments
 
@@ -174,43 +173,3 @@ This function returns a value of type `FileVersionLegalHolds`.
 
 Returns the list of current file versions held under legal hold for a
 specific legal hold policy assignment.
-
-## List previous file versions for legal hold policy assignment
-
-Get a list of previous file versions for a legal hold
-assignment.
-
-In some cases you may only need the latest file versions instead. In these
-cases, use the `GET  /legal_hold_policy_assignments/:id/files_on_hold` API
-instead to return any current (latest) versions of a file for this legal hold
-policy assignment.
-
-Due to ongoing re-architecture efforts this API might not return all files
-held for this policy ID. Instead, this API will only return past file versions
-held in the newly developed architecture. The `GET /file_version_legal_holds`
-API can be used to fetch current and past versions of files held within the
-legacy architecture.
-
-The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to
-find a list of policy assignments for a given policy ID.
-
-This operation is performed by calling function `getLegalHoldPolicyAssignmentFileVersionOnHold`.
-
-See the endpoint docs at
-[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold/).
-
-_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFileVersionOnHold` in integration tests_
-
-### Arguments
-
-- legalHoldPolicyAssignmentId `string`
-  - The ID of the legal hold policy assignment Example: "753465"
-- optionalsInput `GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionalsInput`
-  -
-
-### Returns
-
-This function returns a value of type `FileVersionLegalHolds`.
-
-Returns the list of previous file versions held under legal hold for a
-specific legal hold policy assignment.

docs/retentionPolicyAssignments.md

@@ -5,7 +5,6 @@
 - [Get retention policy assignment](#get-retention-policy-assignment)
 - [Remove retention policy assignment](#remove-retention-policy-assignment)
 - [Get files under retention](#get-files-under-retention)
-- [Get file versions under retention](#get-file-versions-under-retention)
 
 ## List retention policy assignments
 
@@ -165,29 +164,3 @@ This function returns a value of type `FilesUnderRetention`.
 
 Returns a list of files under retention that are associated with the
 specified retention policy assignment.
-
-## Get file versions under retention
-
-Returns a list of file versions under retention for a retention policy
-assignment.
-
-This operation is performed by calling function `getFileVersionsUnderRetentionPolicyAssignment`.
-
-See the endpoint docs at
-[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention/).
-
-_Currently we don't have an example for calling `getFileVersionsUnderRetentionPolicyAssignment` in integration tests_
-
-### Arguments
-
-- retentionPolicyAssignmentId `string`
-  - The ID of the retention policy assignment. Example: "1233123"
-- optionalsInput `GetFileVersionsUnderRetentionPolicyAssignmentOptionalsInput`
-  -
-
-### Returns
-
-This function returns a value of type `FilesUnderRetention`.
-
-Returns a list of file versions under retention that are associated with
-the specified retention policy assignment.

package-lock.json

@@ -174,40 +174,6 @@ export interface GetLegalHoldPolicyAssignmentFileOnHoldOptionalsInput {
   readonly headers?: GetLegalHoldPolicyAssignmentFileOnHoldHeaders;
   readonly cancellationToken?: undefined | CancellationToken;
 }
-export class GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionals {
-  readonly queryParams: GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams =
-    {} satisfies GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams;
-  readonly headers: GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders =
-    new GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders({});
-  readonly cancellationToken?: CancellationToken = void 0;
-  constructor(
-    fields: Omit<
-      GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionals,
-      'queryParams' | 'headers' | 'cancellationToken'
-    > &
-      Partial<
-        Pick<
-          GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionals,
-          'queryParams' | 'headers' | 'cancellationToken'
-        >
-      >
-  ) {
-    if (fields.queryParams) {
-      this.queryParams = fields.queryParams;
-    }
-    if (fields.headers) {
-      this.headers = fields.headers;
-    }
-    if (fields.cancellationToken) {
-      this.cancellationToken = fields.cancellationToken;
-    }
-  }
-}
-export interface GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionalsInput {
-  readonly queryParams?: GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams;
-  readonly headers?: GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
-}
 export type GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField =
   | 'file'
   | 'file_version'
@@ -344,39 +310,6 @@ export interface GetLegalHoldPolicyAssignmentFileOnHoldHeadersInput {
         readonly [key: string]: undefined | string;
       };
 }
-export interface GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams {
-  readonly marker?: string;
-  readonly limit?: number;
-  readonly fields?: readonly string[];
-}
-export class GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders {
-  readonly extraHeaders?: {
-    readonly [key: string]: undefined | string;
-  } = {};
-  constructor(
-    fields: Omit<
-      GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders,
-      'extraHeaders'
-    > &
-      Partial<
-        Pick<
-          GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders,
-          'extraHeaders'
-        >
-      >
-  ) {
-    if (fields.extraHeaders) {
-      this.extraHeaders = fields.extraHeaders;
-    }
-  }
-}
-export interface GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersInput {
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
-}
 export class LegalHoldPolicyAssignmentsManager {
   readonly auth?: Authentication;
   readonly networkSession: NetworkSession = new NetworkSession({});
@@ -389,7 +322,6 @@ export class LegalHoldPolicyAssignmentsManager {
       | 'getLegalHoldPolicyAssignmentById'
       | 'deleteLegalHoldPolicyAssignmentById'
       | 'getLegalHoldPolicyAssignmentFileOnHold'
-      | 'getLegalHoldPolicyAssignmentFileVersionOnHold'
     > &
       Partial<Pick<LegalHoldPolicyAssignmentsManager, 'networkSession'>>
   ) {
@@ -581,50 +513,6 @@ export class LegalHoldPolicyAssignmentsManager {
     )) as FetchResponse;
     return deserializeFileVersionLegalHolds(response.data);
   }
-  async getLegalHoldPolicyAssignmentFileVersionOnHold(
-    legalHoldPolicyAssignmentId: string,
-    optionalsInput: GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionalsInput = {}
-  ): Promise<FileVersionLegalHolds> {
-    const optionals: GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionals =
-      new GetLegalHoldPolicyAssignmentFileVersionOnHoldOptionals({
-        queryParams: optionalsInput.queryParams,
-        headers: optionalsInput.headers,
-        cancellationToken: optionalsInput.cancellationToken,
-      });
-    const queryParams: any = optionals.queryParams;
-    const headers: any = optionals.headers;
-    const cancellationToken: any = optionals.cancellationToken;
-    const queryParamsMap: {
-      readonly [key: string]: string;
-    } = prepareParams({
-      ['marker']: toString(queryParams.marker) as string,
-      ['limit']: toString(queryParams.limit) as string,
-      ['fields']: queryParams.fields
-        ? queryParams.fields.map(toString).join(',')
-        : undefined,
-    });
-    const headersMap: {
-      readonly [key: string]: string;
-    } = prepareParams({ ...{}, ...headers.extraHeaders });
-    const response: FetchResponse = (await fetch(
-      ''.concat(
-        this.networkSession.baseUrls.baseUrl,
-        '/legal_hold_policy_assignments/',
-        toString(legalHoldPolicyAssignmentId) as string,
-        '/file_versions_on_hold'
-      ) as string,
-      {
-        method: 'GET',
-        params: queryParamsMap,
-        headers: headersMap,
-        responseFormat: 'json',
-        auth: this.auth,
-        networkSession: this.networkSession,
-        cancellationToken: cancellationToken,
-      } satisfies FetchOptions
-    )) as FetchResponse;
-    return deserializeFileVersionLegalHolds(response.data);
-  }
 }
 export interface LegalHoldPolicyAssignmentsManagerInput {
   readonly auth?: Authentication;

src/managers/legalHoldPolicyAssignments.generated.ts

@@ -186,40 +186,6 @@ export interface GetFilesUnderRetentionPolicyAssignmentOptionalsInput {
   readonly headers?: GetFilesUnderRetentionPolicyAssignmentHeaders;
   readonly cancellationToken?: undefined | CancellationToken;
 }
-export class GetFileVersionsUnderRetentionPolicyAssignmentOptionals {
-  readonly queryParams: GetFileVersionsUnderRetentionPolicyAssignmentQueryParams =
-    {} satisfies GetFileVersionsUnderRetentionPolicyAssignmentQueryParams;
-  readonly headers: GetFileVersionsUnderRetentionPolicyAssignmentHeaders =
-    new GetFileVersionsUnderRetentionPolicyAssignmentHeaders({});
-  readonly cancellationToken?: CancellationToken = void 0;
-  constructor(
-    fields: Omit<
-      GetFileVersionsUnderRetentionPolicyAssignmentOptionals,
-      'queryParams' | 'headers' | 'cancellationToken'
-    > &
-      Partial<
-        Pick<
-          GetFileVersionsUnderRetentionPolicyAssignmentOptionals,
-          'queryParams' | 'headers' | 'cancellationToken'
-        >
-      >
-  ) {
-    if (fields.queryParams) {
-      this.queryParams = fields.queryParams;
-    }
-    if (fields.headers) {
-      this.headers = fields.headers;
-    }
-    if (fields.cancellationToken) {
-      this.cancellationToken = fields.cancellationToken;
-    }
-  }
-}
-export interface GetFileVersionsUnderRetentionPolicyAssignmentOptionalsInput {
-  readonly queryParams?: GetFileVersionsUnderRetentionPolicyAssignmentQueryParams;
-  readonly headers?: GetFileVersionsUnderRetentionPolicyAssignmentHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
-}
 export type GetRetentionPolicyAssignmentsQueryParamsTypeField =
   | 'folder'
   | 'enterprise'
@@ -360,38 +326,6 @@ export interface GetFilesUnderRetentionPolicyAssignmentHeadersInput {
         readonly [key: string]: undefined | string;
       };
 }
-export interface GetFileVersionsUnderRetentionPolicyAssignmentQueryParams {
-  readonly marker?: string;
-  readonly limit?: number;
-}
-export class GetFileVersionsUnderRetentionPolicyAssignmentHeaders {
-  readonly extraHeaders?: {
-    readonly [key: string]: undefined | string;
-  } = {};
-  constructor(
-    fields: Omit<
-      GetFileVersionsUnderRetentionPolicyAssignmentHeaders,
-      'extraHeaders'
-    > &
-      Partial<
-        Pick<
-          GetFileVersionsUnderRetentionPolicyAssignmentHeaders,
-          'extraHeaders'
-        >
-      >
-  ) {
-    if (fields.extraHeaders) {
-      this.extraHeaders = fields.extraHeaders;
-    }
-  }
-}
-export interface GetFileVersionsUnderRetentionPolicyAssignmentHeadersInput {
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
-}
 export class RetentionPolicyAssignmentsManager {
   readonly auth?: Authentication;
   readonly networkSession: NetworkSession = new NetworkSession({});
@@ -404,7 +338,6 @@ export class RetentionPolicyAssignmentsManager {
       | 'getRetentionPolicyAssignmentById'
       | 'deleteRetentionPolicyAssignmentById'
       | 'getFilesUnderRetentionPolicyAssignment'
-      | 'getFileVersionsUnderRetentionPolicyAssignment'
     > &
       Partial<Pick<RetentionPolicyAssignmentsManager, 'networkSession'>>
   ) {
@@ -605,47 +538,6 @@ export class RetentionPolicyAssignmentsManager {
     )) as FetchResponse;
     return deserializeFilesUnderRetention(response.data);
   }
-  async getFileVersionsUnderRetentionPolicyAssignment(
-    retentionPolicyAssignmentId: string,
-    optionalsInput: GetFileVersionsUnderRetentionPolicyAssignmentOptionalsInput = {}
-  ): Promise<FilesUnderRetention> {
-    const optionals: GetFileVersionsUnderRetentionPolicyAssignmentOptionals =
-      new GetFileVersionsUnderRetentionPolicyAssignmentOptionals({
-        queryParams: optionalsInput.queryParams,
-        headers: optionalsInput.headers,
-        cancellationToken: optionalsInput.cancellationToken,
-      });
-    const queryParams: any = optionals.queryParams;
-    const headers: any = optionals.headers;
-    const cancellationToken: any = optionals.cancellationToken;
-    const queryParamsMap: {
-      readonly [key: string]: string;
-    } = prepareParams({
-      ['marker']: toString(queryParams.marker) as string,
-      ['limit']: toString(queryParams.limit) as string,
-    });
-    const headersMap: {
-      readonly [key: string]: string;
-    } = prepareParams({ ...{}, ...headers.extraHeaders });
-    const response: FetchResponse = (await fetch(
-      ''.concat(
-        this.networkSession.baseUrls.baseUrl,
-        '/retention_policy_assignments/',
-        toString(retentionPolicyAssignmentId) as string,
-        '/file_versions_under_retention'
-      ) as string,
-      {
-        method: 'GET',
-        params: queryParamsMap,
-        headers: headersMap,
-        responseFormat: 'json',
-        auth: this.auth,
-        networkSession: this.networkSession,
-        cancellationToken: cancellationToken,
-      } satisfies FetchOptions
-    )) as FetchResponse;
-    return deserializeFilesUnderRetention(response.data);
-  }
 }
 export interface RetentionPolicyAssignmentsManagerInput {
   readonly auth?: Authentication;