Skip to content

Commit 14f0381

Browse files
author
Kate Brune
committed
add documentation
1 parent 179ab6e commit 14f0381

File tree

3 files changed

+83
-3
lines changed

3 files changed

+83
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ Class | Method | HTTP request | Description
199199
*DefaultApi* | [**updateAnAccount**](docs/DefaultApi.md#updateAnAccount) | **POST** /Accounts/{accountId} | Manage an account
200200
*DefaultApi* | [**updateAnApplication**](docs/DefaultApi.md#updateAnApplication) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
201201
*DefaultApi* | [**updateAnIncomingNumber**](docs/DefaultApi.md#updateAnIncomingNumber) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
202-
202+
| *DefaultApi* | [**getNextPage**](docs/DefaultApi.md#getNextPage) | **GET** | Get next page of paginated resource
203203
204204
## Documentation for Models
205205

docs/DefaultApi.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Method | HTTP request | Description
6060
[**updateAnAccount**](DefaultApi.md#updateAnAccount) | **POST** /Accounts/{accountId} | Manage an account
6161
[**updateAnApplication**](DefaultApi.md#updateAnApplication) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
6262
[**updateAnIncomingNumber**](DefaultApi.md#updateAnIncomingNumber) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
63-
63+
[**getNextPage**](DefaultApi.md#getNextPage) | **GET** | Get next page of paginated resource
6464

6565
<a name="buyAPhoneNumber"></a>
6666
# **buyAPhoneNumber**
@@ -4020,3 +4020,70 @@ Name | Type | Description | Notes
40204020
|-------------|-------------|------------------|
40214021
**200** | Updated Incoming Phone Number | - |
40224022

4023+
4024+
<a name="getNextPage"></a>
4025+
# **getNextPage**
4026+
> <T extends Pagination> T getNextPage(T response)
4027+
4028+
Get next page of paginated resource
4029+
4030+
### Example
4031+
```java
4032+
// Import classes:
4033+
import com.github.freeclimbapi.ApiClient;
4034+
import com.github.freeclimbapi.ApiException;
4035+
import com.github.freeclimbapi.Configuration;
4036+
import com.github.freeclimbapi.auth.*;
4037+
import com.github.freeclimbapi.models.*;
4038+
import com.github.freeclimbapi.DefaultApi;
4039+
4040+
public class Example {
4041+
public static void main(String[] args) {
4042+
4043+
ApiClient defaultClient = Configuration.getDefaultApiClient();
4044+
defaultClient.setBasePath("https://www.freeclimb.com/apiserver");
4045+
defaultClient.setAccountId("YOUR_ACCOUNT_ID");
4046+
defaultClient.setApiKey("YOUR_API_KEY");
4047+
4048+
4049+
DefaultApi apiInstance = new DefaultApi(defaultClient);
4050+
4051+
String alias = "alias_example";
4052+
4053+
try {
4054+
ApplicationList result = apiInstance.listApplications(alias);
4055+
System.out.println(result);
4056+
ApplicationList nextPageResult = apiInstance.getNextPage(result);
4057+
System.out.println(nextPageResult);
4058+
} catch (ApiException e) {
4059+
System.err.println("Exception")
4060+
System.err.println("Status code: " + e.getCode());
4061+
e.printStackTrace();
4062+
}
4063+
}
4064+
}
4065+
```
4066+
4067+
### Parameters
4068+
Name | Type | Description | Notes
4069+
------------- | ------------- | ------------- | -------------
4070+
response | T extends Pagination | Previous response from request to get paginated resource |
4071+
4072+
### Return type
4073+
4074+
**T**
4075+
4076+
### Authorization
4077+
4078+
[fc](../README.md#fc)
4079+
4080+
### HTTP request headers
4081+
4082+
- **Content-Type**: Not defined
4083+
- **Accept**: application/json
4084+
4085+
### HTTP response details
4086+
| Status code | Description | Response headers |
4087+
|-------------|-------------|------------------|
4088+
| **200** | List of paginated resource | - |
4089+
Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
package com.github.freeclimbapi.utils;
22

33
public interface Pagination {
4+
public Integer getTotal();
5+
public void setTotal(Integer total);
6+
public Integer getStart();
7+
public void setStart(Integer start);
8+
public Integer getEnd();
9+
public void setEnd(Integer end);
10+
public Integer getPage();
11+
public void setPage(Integer page);
12+
public Integer getNumPages();
13+
public void setNumPages(Integer numPages);
14+
public Integer getPageSize();
15+
public void setPageSize(Integer pageSize);
416
public String getNextPageUri();
5-
}
17+
public void setNextPageUri(String nextPageUri);
18+
}

0 commit comments

Comments
 (0)