Merge pull request #76 from FreeClimbAPI/VCSWP-18370

 Resolve VCSWP-18370: Pagination for node.js SDK

Author: lunderwood99

CHANGELOG.md

@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="3.7.0"></a>
+
+## [3.7.0] - 2024-08-28
+
+### Add
+
+- getNextPage functions to PromiseApi, DefaultApi, and ObservableApi
+
 <a name="3.6.2"></a>
 
 ## [3.6.2] - 2024-07-31

DefaultApi.md

@@ -60,7 +60,7 @@ Method | HTTP request | Description
 [**updateAnAccount**](DefaultApi.md#updateAnAccount) | **POST** /Accounts/{accountId} | Manage an account
 [**updateAnApplication**](DefaultApi.md#updateAnApplication) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
 [**updateAnIncomingNumber**](DefaultApi.md#updateAnIncomingNumber) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
-
+[**getNextPage**](DefaultApi.md#getNextPage) | **GET** /Accounts/{accountId}/{nextPageUri} | Get Next Page of Resource Data
 
 # **buyAPhoneNumber**
 > IncomingNumberResult buyAPhoneNumber(buyIncomingNumberRequest)
@@ -3590,3 +3590,62 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
 
 
+# **getNextPage**
+> PaginationModel<T> getNextPage<T>()
+
+### Example
+
+
+```typescript
+import { freeclimb } from '@freeclimb';
+import * as fs from 'fs';
+
+const configuration = freeclimb.createConfiguration({
+  accountId: 'YOUR_ACCOUND_ID',
+  apiKey: 'YOUR_API_KEY'
+});
+const apiInstance = new freeclimb.DefaultApi(configuration);
+
+let body:freeclimb.DefaultApiListCallRecordingsRequest = {
+
+  // string | String that uniquely identifies this call resource.
+  callId: "callId_example",
+
+  // string | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. (optional)
+  dateCreated: "dateCreated_example",
+
+};
+
+const recordingsResponse = await apiInstance.listCallRecordings(body)
+
+await apiInstance.getNextPage(recordingsResponse).then((data:any) => {
+  console.log('Next page fetched succesfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+Name               | Type                     | Description                                    | Notes
+------------------ | ------------------------ | ---------------------------------------------- | ---------------------               
+**responseObject** | [**PaginationModel<T>**] | Response from resource used to fetch next page | defaults to undefined
+
+### Return type
+
+**PaginationModel<T>**
+
+### Authorization
+
+[fc](README.md#fc)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Next page of resource data |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+

LICENSE.txt

@@ -1,7 +1,7 @@
 MIT License
 -------------
 
-Copyright (c) 2023 FreeClimbAPI
+Copyright (c) 2024 FreeClimbAPI
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -14,9 +14,9 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
 ## Installing
 
 ```sh
-npm install @freeclimb/sdk@3.6.2
+npm install @freeclimb/sdk@3.7.0
 or 
-yarn add @freeclimb/sdk@3.6.2
+yarn add @freeclimb/sdk@3.7.0
 ```
 
 ## Getting Started 

__tests__/DefaultApi.spec.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "@jest/globals";
+import { describe, expect, test, beforeAll } from "@jest/globals";
 import * as freeclimb  from '../index'
 import * as DefaultApi from '../apis/DefaultApi'
 import { AccountRequest, AccountResult, ApplicationList, ApplicationRequest, ApplicationResult, AvailableNumberList, BuyIncomingNumberRequest, CallList, CallResult, ConferenceList, ConferenceParticipantList, ConferenceParticipantResult, ConferenceResult, CreateConferenceRequest, FilterLogsRequest, IncomingNumberList, IncomingNumberRequest, IncomingNumberResult, LogList, MessageResult, MessagesList, QueueList, QueueMember, QueueMemberList, QueueRequest, QueueResult, RecordingList, RecordingResult, ServerConfiguration, UpdateCallRequest, UpdateConferenceRequest } from "../index";
@@ -455,5 +455,42 @@ describe('DefaultAPI', () => {
         let data = await apiInstance.listConferenceRecordings(callId, conferenceId, dateCreated)
         expect(data).toBeInstanceOf(RecordingList)
     });
+
+    test('#getNextPage', async () => {
+        const responseObject: RecordingList = {
+            total: 0,
+            start: 0,
+            end: 0,
+            page: 0,
+            numPages: 0,
+            pageSize: 0,
+            nextPageUri: '/Recordings?cursor=1',
+            recordings: []
+        }
+        const expectedResponseObject: RecordingList = {
+            total: 0,
+            start: 0,
+            end: 0,
+            page: 0,
+            numPages: 0,
+            pageSize: 0,
+            nextPageUri: 'string',
+            recordings: [
+                {
+                    accountId: "string",
+                    callId: "string",
+                    conferenceId: "string",
+                    dateCreated: "string",
+                    dateUpdated: "string",
+                    durationSec: 0,
+                    recordingId: "string",
+                    revision: 0,
+                    uri: "string",
+                }
+            ]
+        }
+        let data = await apiInstance.getNextPage(responseObject)
+        expect(data).toStrictEqual(expectedResponseObject)
+    });
 })
 

apis/DefaultApi.ts

@@ -4,7 +4,7 @@ import {Configuration} from '../configuration';
 import {RequestContext, HttpMethod, ResponseContext, HttpFile} from '../http/http';
 import * as FormData from "form-data";
 import { URLSearchParams } from 'url';
-import {ObjectSerializer} from '../models/ObjectSerializer';
+import {ObjectSerializer, PaginationModel} from '../models/ObjectSerializer';
 import {ApiException} from './exception';
 import {canConsumeForm, isCodeInRange} from '../util';
 import {SecurityAuthentication} from '../auth/auth';
@@ -2483,6 +2483,30 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
         return requestContext;
     }
 
+
+    public async getNextPage<T extends PaginationModel>(responseObject: T, _options?: Configuration): Promise<RequestContext> {
+        const _config = _options || this.configuration;
+        const { accountId } = this.configuration
+        // Path Params
+        const localVarPath = `/Accounts/{accountId}${responseObject.nextPageUri}`
+            .replace('{' + 'accountId' + '}', encodeURIComponent(String(accountId)));
+        // Make Request Context
+        const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET);
+        requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
+        
+
+        let authMethod: SecurityAuthentication | undefined;
+        // Apply auth methods
+        authMethod = _config.authMethods["fc"]
+        if (authMethod?.applySecurityAuthentication) {
+            await authMethod?.applySecurityAuthentication(requestContext);
+        }
+        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        if (defaultAuth?.applySecurityAuthentication) {
+            await defaultAuth?.applySecurityAuthentication(requestContext);
+        }
+        return requestContext;
+    }
 }
 
 export class DefaultApiResponseProcessor {
@@ -4077,4 +4101,24 @@ export class DefaultApiResponseProcessor {
         throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
     }
 
+
+    public async getNextPage<T extends PaginationModel>(response: ResponseContext): Promise<T> {
+        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+        if (isCodeInRange("200", response.httpStatusCode)) {
+            const body: T = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "T", ""
+            ) as T;
+            return body;
+        }
+        // Work around for missing responses in specification, e.g. for petstore.yaml
+        if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+            const body: T = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "T", ""
+            ) as T;
+            return body;
+        }
+        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
+    }
 }

models/AddToConference.ts

@@ -39,7 +39,7 @@ import { Unpark } from './Unpark';
 import { HttpFile } from '../http/http';
 
 /**
-* The `AddToConference` command adds a Participant to a Conference. If this Participant currently is in another Conference, the Participant is first removed from that Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.
+* The `AddToConference` command adds a Participant to a Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.
 */
 
 interface AttributeType {