DEVEXP-505: E2E ElasticSipTrunking/AccessControlLists

packages/elastic-sip-trunking/src/models/v1/create-access-control-list-request/create-access-control-list-request.ts

@@ -0,0 +1,10 @@
+import { IpRangeRequest } from '../ip-range';
+
+export interface CreateAccessControlListRequest {
+  /** Your name for the access control list entry. */
+  name: string;
+  /** Whether the access control list entry is enabled. You can use this to disable a list temporarily without deleting it. */
+  enabled?: boolean;
+  /** An array of all the IP ranges to create. */
+  ipRanges: IpRangeRequest[];
+}

packages/elastic-sip-trunking/src/models/v1/create-access-control-list-request/index.ts

@@ -0,0 +1 @@
+export type { CreateAccessControlListRequest } from './create-access-control-list-request';

packages/elastic-sip-trunking/src/models/v1/index.ts

@@ -2,6 +2,7 @@ export * from './access-control-list';
 export * from './add-access-control-list-to-trunk';
 export * from './call';
 export * from './country-permission';
+export * from './create-access-control-list-request';
 export * from './ip-range';
 export * from './list-country-permissions-response';
 export * from './money';

packages/elastic-sip-trunking/src/models/v1/ip-range/index.ts

@@ -1 +1 @@
-export type { IpRange } from './ip-range';
+export type { IpRange, IpRangeRequest } from './ip-range';

packages/elastic-sip-trunking/src/models/v1/ip-range/ip-range.ts

@@ -19,3 +19,5 @@ export interface IpRange {
   /** The ID of the access control list. */
   accessControlListId?: string;
 }
+
+export type IpRangeRequest = Omit<IpRange, 'accessControlListId' | 'id' | 'createTime' | 'updateTime' | 'projectId'>;

packages/elastic-sip-trunking/src/models/v1/requests/access-control-list/access-control-list-request-data.ts

@@ -1,16 +1,16 @@
-import { AccessControlList } from '../../access-control-list';
-import { IpRange } from '../../ip-range';
+import { IpRangeRequest } from '../../ip-range';
 import { UpdateAccessControlListRequest } from '../../update-access-control-list-request';
+import { CreateAccessControlListRequest } from '../../create-access-control-list-request';
 
 export interface AddIpRangeToAccessControlListRequestData {
     /** The ID of the access control list entry. that you want to work with */
     'accessControlListId': string;
     /**  */
-    'addIpRangeRequestBody': IpRange;
+    'addIpRangeRequestBody': IpRangeRequest;
 }
 export interface CreateAccessControlListRequestData {
     /** The Access Control List details used to create an Access Control List */
-    'createAccessControlListBody': AccessControlList;
+    'createAccessControlListBody': CreateAccessControlListRequest;
 }
 export interface DeleteAccessControlListRequestData {
     /** The ID of the access control list entry. */
@@ -22,6 +22,10 @@ export interface DeleteIpRangeFromAccessControlListRequestData {
     /** The ID of the IP range that you want to update. */
     'ipRangeId': string;
 }
+export interface GetAccessControlListRequestData {
+    /** The ID of the access control list entry that you want to retrieve. */
+    'id': string;
+}
 export interface ListAccessControlListRequestData {
 }
 export interface ListIpRangesForAccessControlListRequestData {
@@ -40,5 +44,5 @@ export interface UpdateIpRangeFromAccessControlListRequestData {
     /** The ID of the IP range that you want to update. */
     'ipRangeId': string;
     /** The IP range details used to update the IP range property from an Access Control List */
-    'updateIpRangeRequestBody': IpRange;
+    'updateIpRangeRequestBody': IpRangeRequest;
 }

packages/elastic-sip-trunking/src/models/v1/update-access-control-list-request/update-access-control-list-request.ts

@@ -1,10 +1,10 @@
-import { IpRange } from '../ip-range';
+import { IpRangeRequest } from '../ip-range';
 
 export interface UpdateAccessControlListRequest {
   /** Your name for the access control list entry. */
   name: string;
   /** Whether the access control list entry is enabled. You can use this to disable a list temporarily without deleting it. */
   enabled?: boolean;
   /** An array of all the IP ranges to update. */
-  ipRanges?: IpRange[];
+  ipRanges?: IpRangeRequest[];
 }

packages/elastic-sip-trunking/src/rest/v1/access-control-list/access-control-list-api.jest.fixture.ts

@@ -14,6 +14,7 @@ import {
   UpdateAccessControlListRequestData,
   UpdateIpRangeFromAccessControlListRequestData,
   AddAccessControlListToTrunk,
+  GetAccessControlListRequestData,
 } from '../../../models';
 import { ApiListPromise } from '@sinch/sdk-client';
 
@@ -44,6 +45,11 @@ export class AccessControlListApiFixture implements Partial<Readonly<AccessContr
    */
   public create: jest.Mock<
     Promise<AccessControlList>, [CreateAccessControlListRequestData]> = jest.fn();
+  /**
+   * Fixture associated to function get
+   */
+  public get: jest.Mock<
+    Promise<AccessControlList>, [GetAccessControlListRequestData]> = jest.fn();
   /**
    * Fixture associated to function delete
    */

packages/elastic-sip-trunking/src/rest/v1/access-control-list/access-control-list-api.ts

@@ -13,6 +13,7 @@ import {
   ListAccessControlListsForTrunkRequestData,
   AddAccessControlListToTrunk,
   IpRange,
+  GetAccessControlListRequestData,
 } from '../../../models';
 import {
   RequestBody,
@@ -183,6 +184,33 @@ export class AccessControlListApi extends ElasticSipTrunkingDomainApi {
     });
   }
 
+  /**
+   * Get Access Control List
+   * Search for an Access Control List by ID.
+   * @param { GetAccessControlListRequestData } data - The data to provide to the API call.
+   */
+  public async get(data: GetAccessControlListRequestData): Promise<AccessControlList> {
+    this.client = this.getSinchClient();
+    const getParams = this.client.extractQueryParams<GetAccessControlListRequestData>(data, [] as never[]);
+    const headers: { [key: string]: string | undefined } = {
+      'Content-Type': 'application/json',
+      'Accept': 'application/json',
+    };
+
+    const body: RequestBody = '';
+    const basePathUrl = `${this.client.apiClientOptions.hostname}/v1/projects/${this.client.apiClientOptions.projectId}/accessControlLists/${data['id']}`;
+
+    const requestOptions = await this.client.prepareOptions(basePathUrl, 'GET', getParams, headers, body || undefined);
+    const url = this.client.prepareUrl(requestOptions.hostname, requestOptions.queryParams);
+
+    return this.client.processCall<AccessControlList>({
+      url,
+      requestOptions,
+      apiName: this.apiName,
+      operationId: 'GetAccessControlListById',
+    });
+  }
+
   /**
    * List ACLs
    * Fetches the list of Access Control List entries.
@@ -205,7 +233,7 @@ export class AccessControlListApi extends ElasticSipTrunkingDomainApi {
     const operationProperties: PaginatedApiProperties = {
       pagination: PaginationEnum.PAGE2,
       apiName: this.apiName,
-      operationId: 'GetAccessControlList',
+      operationId: 'GetAccessControlLists',
       dataKey: 'accessControlLists',
     };
 

packages/elastic-sip-trunking/tests/rest/v1/access-control-list/access-control-list-api.test.ts

@@ -131,6 +131,45 @@ describe('AccessControlListApi', () => {
     });
   });
 
+  describe ('getAccessControlListById', () => {
+    // eslint-disable-next-line max-len
+    it('should make a GET request to retrieve an access control list', async () => {
+      // Given
+      const requestData: ElasticSipTrunking.GetAccessControlListRequestData = {
+        id: '01HA9BRJW4J3QE4WBKVC337V4E',
+      };
+      const expectedResponse: ElasticSipTrunking.AccessControlList = {
+        name: 'My new ACL',
+        projectId: '3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47',
+        enabled: true,
+        id: '01HA9BRJW4J3QE4WBKVC337V4E',
+        createTime: new Date('2023-09-14T07:39:19Z'),
+        updateTime: null,
+        ipRanges: [
+          {
+            description: 'Location 1',
+            ipAddress: '15.15.15.15',
+            range: 20,
+            projectId: '3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47',
+            accessControlListId: '01HA9BRJW4J3QE4WBKVC337V4E',
+            id: '01HA9BRJYR9Q7ZBDYMXHVWT8S8',
+            createTime: new Date('2023-09-14T07:39:19Z'),
+            updateTime: null,
+          },
+        ],
+      };
+
+      // When
+      fixture.get.mockResolvedValue(expectedResponse);
+      accessControlListApi.get = fixture.get;
+      const response = await accessControlListApi.get(requestData);
+
+      // Then
+      expect(response).toEqual(expectedResponse);
+      expect(fixture.get).toHaveBeenCalledWith(requestData);
+    });
+  });
+
   describe ('deleteAccessControlList', () => {
     it('should make a DELETE request to delete an access control list entry', async () => {
       // Given
@@ -187,7 +226,7 @@ describe('AccessControlListApi', () => {
     });
   });
 
-  describe ('getAccessControlList', () => {
+  describe ('getAccessControlLists', () => {
     it('should make a GET request to fetch the list of Access Control List entries', async () => {
       // Given
       const requestData: ElasticSipTrunking.ListAccessControlListRequestData = {};