ACS-8055 add HoldPaging class and documentation

lib/js-api/src/api/content-rest-api/model/nodeChildAssociation.ts

@@ -49,8 +49,6 @@ export class NodeChildAssociation {
     permissions?: PermissionsInfo;
     definition?: Definition;
     association?: ChildAssociationInfo;
-    reason?: string;
-    description?: string;
 
     constructor(input?: Partial<NodeChildAssociation>) {
         if (input) {

lib/js-api/src/api/gs-core-rest-api/api/legal-hold.api.ts

@@ -17,7 +17,8 @@
 
 import { BaseApi } from './base.api';
 import { throwIfNotDefined } from '../../../assert';
-import { ContentPagingQuery, NodeChildAssociationPaging } from '../../content-rest-api';
+import { ContentPagingQuery } from '../../content-rest-api';
+import { HoldPaging } from '../model/holdPaging';
 
 /**
  * Legal Holds service.
@@ -29,10 +30,10 @@ export class LegalHoldApi extends BaseApi {
      * List of legal holds
      *
      * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
-     * @param opt Optional parameters
+     * @param options Optional parameters
-     * @returns Promise<NodeChildAssociationPaging>
+     * @returns Promise<HoldPaging>
      */
-    getHolds(filePlanId: string = '-filePlan-', opts?: ContentPagingQuery): Promise<NodeChildAssociationPaging> {
+    getHolds(filePlanId: string = '-filePlan-', options?: ContentPagingQuery): Promise<HoldPaging> {
         throwIfNotDefined(filePlanId, 'filePlanId');
 
         const pathParams = {
@@ -40,15 +41,15 @@ export class LegalHoldApi extends BaseApi {
         };
 
         const queryParams = {
-            skipCount: opts?.skipCount,
+            skipCount: options?.skipCount,
-            maxItems: opts?.maxItems
+            maxItems: options?.maxItems
         };
 
         return this.get({
             path: '/file-plans/{filePlanId}/holds',
             pathParams,
             queryParams,
-            returnType: NodeChildAssociationPaging
+            returnType: HoldPaging
         });
     }
 }

lib/js-api/src/api/gs-core-rest-api/docs/Hold.md

@@ -4,8 +4,8 @@
 
 ```ts
 export interface Hold {
-    id: string;
     name: string;
+    id?: string;
     reason?: string;
     description?: string;
     selected?: string;
@@ -19,4 +19,4 @@ Name | Type | Default value | Description
 **id** | **string** |  | Hold id
 **name** | **string** |  | Hold name
 **reason** | **string** |  | Hold reason
-**description** | **string** |  | [optional] [Additional information for a hold]
+**description** | **string** |  | Additional information for a hold

lib/js-api/src/api/gs-core-rest-api/docs/HoldEntry.md

@@ -0,0 +1,6 @@
+# HoldEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**Hold**](Hold.md) |  | [default to null]

lib/js-api/src/api/gs-core-rest-api/docs/HoldPaging.md

@@ -0,0 +1,8 @@
+# HoldPaging
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**HoldPagingList**](HoldPagingList.md) |  | [optional] [default to null]
+
+

lib/js-api/src/api/gs-core-rest-api/docs/HoldPagingList.md

@@ -0,0 +1,7 @@
+# HoldPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] [default to null]
+**entries** | [**HoldEntry[]**](HoldEntry.md) |  | [optional] [default to null]

lib/js-api/src/api/gs-core-rest-api/docs/LegalHoldApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 <a name="getHolds"></a>
 # **getHolds**
-> NodeChildAssociationPaging getHolds(filePlanId, opts)
+> HoldPaging getHolds(filePlanId, opts)
 
 Get legal holds list.
 
@@ -47,4 +47,4 @@ Name | Type | Default value  | Description
 
 ### Return type
 
-[**NodeChildAssociationPaging**](NodeChildAssociationPaging.md)
+[**HoldPaging**](HoldPaging.md)

lib/js-api/src/api/gs-core-rest-api/model/holdEntry.ts

@@ -0,0 +1,28 @@
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Hold } from '..';
+
+export class HoldEntry {
+    entry: Hold;
+
+    constructor(input?: Partial<HoldEntry>) {
+        if (input) {
+            Object.assign(this, input);
+        }
+    }
+}

lib/js-api/src/api/gs-core-rest-api/model/holdPaging.ts

@@ -0,0 +1,29 @@
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { HoldPagingList } from './holdPagingList';
+
+export class HoldPaging {
+    list?: HoldPagingList;
+
+    constructor(input?: Partial<HoldPaging>) {
+        if (input) {
+            Object.assign(this, input);
+            this.list = input.list ? new HoldPagingList(input.list) : undefined;
+        }
+    }
+}

lib/js-api/src/api/gs-core-rest-api/model/holdPagingList.ts

@@ -0,0 +1,34 @@
+/*!
+ * @license
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Pagination } from '../../content-rest-api';
+import { HoldEntry } from './holdEntry';
+
+export class HoldPagingList {
+    pagination?: Pagination;
+    entries?: HoldEntry[];
+
+    constructor(input?: Partial<HoldPagingList>) {
+        if (input) {
+            Object.assign(this, input);
+            this.pagination = input.pagination ? new Pagination(input.pagination) : undefined;
+            if (input.entries) {
+                this.entries = input.entries.map((item) => new HoldEntry(item));
+            }
+        }
+    }
+}

lib/js-api/src/api/gs-core-rest-api/model/index.ts

@@ -75,3 +75,6 @@ export * from './transferContainerChildAssociation';
 export * from './unfiledContainerChildAssociation';
 export * from './unfiledRecordFolderChildAssociation';
 export * from './hold';
+export * from './holdEntry';
+export * from './holdPaging';
+export * from './holdPagingList';