Skip to content

Commit b6ea385

Browse files
author
Kate Brune
committed
update docs
1 parent fb6da4f commit b6ea385

4 files changed

Lines changed: 76 additions & 5 deletions

File tree

‎.openapi-generator/FILES‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,5 +301,4 @@ requirements.txt
301301
setup.cfg
302302
setup.py
303303
test/__init__.py
304-
test/test_default_api.py
305304
tox.ini

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Class | Method | HTTP request | Description
183183
*DefaultApi* | [**update_an_account**](docs/DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
184184
*DefaultApi* | [**update_an_application**](docs/DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
185185
*DefaultApi* | [**update_an_incoming_number**](docs/DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
186-
186+
*DefaultApi* | [get_next_page](docs/DefaultApi.md#get_next_page) | **GET** | Get Next Page of Paginated List Resource
187187

188188
## Documentation For Models
189189

‎docs/DefaultApi.md‎

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Method | HTTP request | Description
6060
[**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
6161
[**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
6262
[**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
63-
63+
[**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get Next Page of Paginated List Resource
6464

6565
# **buy_a_phone_number**
6666
> IncomingNumberResult buy_a_phone_number(account_id, buy_incoming_number_request)
@@ -4747,3 +4747,76 @@ Name | Type | Description | Notes
47474747

47484748
[[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)
47494749

4750+
4751+
# **get_next_page**
4752+
4753+
> (type(response)) get_next_page(response)
4754+
4755+
Get Next Page of Paginated List Resource
4756+
4757+
### Example
4758+
4759+
* Basic Authentication (fc):
4760+
4761+
```typescript
4762+
import time
4763+
import freeclimb
4764+
from freeclimb.api import default_api
4765+
from freeclimb.model.call_status import CallStatus
4766+
from freeclimb.model.call_list import CallList
4767+
from pprint import pprint
4768+
# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
4769+
# See configuration.py for a list of all supported configuration parameters.
4770+
configuration = freeclimb.Configuration(
4771+
host = "https://www.freeclimb.com/apiserver"
4772+
)
4773+
4774+
# The client must configure the authentication and authorization parameters
4775+
# in accordance with the API server security policy.
4776+
# Examples for each auth method are provided below, use the example that
4777+
# satisfies your auth use case.
4778+
4779+
# Configure HTTP basic authorization: fc
4780+
configuration = freeclimb.Configuration(
4781+
username = 'ACCOUNT_ID',
4782+
password = 'API_KEY'
4783+
)
4784+
4785+
# Enter a context with an instance of the API client
4786+
with freeclimb.ApiClient(configuration) as api_client:
4787+
# Create an instance of the API class
4788+
api_instance = default_api.DefaultApi(api_client)
4789+
4790+
try:
4791+
api_response = api_instance.list_calls()
4792+
pprint(api_response)
4793+
next_page_response = api_instance.get_next_page(api_response)
4794+
pprint(next_page_response)
4795+
except freeclimb.ApiException as e:
4796+
print("Exception when calling DefaultApi->list_calls: %s\n" % e)
4797+
```
4798+
4799+
### Parameters
4800+
4801+
Name | Type | Description | Notes
4802+
------------- | ------------- | ------------- | -------------
4803+
response | Any | Response from operation to list an API resource |
4804+
4805+
### Return type
4806+
4807+
type(response)
4808+
4809+
### Authorization
4810+
4811+
[fc](../README.md#fc)
4812+
4813+
### HTTP request headers
4814+
4815+
- **Content-Type**: Not defined
4816+
- **Accept**: application/json
4817+
4818+
### HTTP response details
4819+
4820+
| Status code | Description | Response headers |
4821+
|-------------|-------------|------------------|
4822+
| 200 | Successful retrieved resource list | - |

‎openapi.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4286,6 +4286,7 @@
42864286
"tags": [],
42874287
"summary": "Make a Call",
42884288
"operationId": "make-a-call",
4289+
"x-is-paginated": true,
42894290
"parameters": [
42904291
{
42914292
"$ref": "#/components/parameters/AccountId"
@@ -4319,7 +4320,6 @@
43194320
"tags": [],
43204321
"summary": "List Calls",
43214322
"operationId": "list-calls",
4322-
"x-is-paginated": true,
43234323
"parameters": [
43244324
{
43254325
"name": "active",
@@ -5147,7 +5147,6 @@
51475147
"tags": [],
51485148
"summary": "List Members",
51495149
"operationId": "list-members",
5150-
"x-is-paginated": "true",
51515150
"parameters": [
51525151
{
51535152
"$ref": "#/components/parameters/AccountId"

0 commit comments

Comments
 (0)