Skip to content

Commit 5c30ae1

Browse files
committed
Update documentation with example references
1 parent 8c4b450 commit 5c30ae1

126 files changed

Lines changed: 1824 additions & 422 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -379,10 +379,10 @@ Authentication schemes defined for the API:
379379

380380
class RequestVerifierExample():
381381
def verify_request_signature_example():
382-
request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
382+
request_body = "{\"accountId\":\"AC0123456789abcdefABCDEF0123456789abcdef00\",\"callId\":\"CA0123456789abcdefABCDEF0123456789abcdef00\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
383383
signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
384384
tolerance = 5 * 60
385-
request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
385+
request_header = "t=1679944186,v1=2f33654710a27e57828fa8556c2ed47c7a324aca88f155e296579e2ae851ce7b,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
386386
RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance)
387387
```
388388

‎docs/AccountRequest.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ Name | Type | Description | Notes
1313
```python
1414
from freeclimb.models.account_request import AccountRequest
1515

16-
# TODO update the JSON string below
17-
json = "{}"
16+
json = """{
17+
"alias": "My Account",
18+
"label": "My Label"
19+
}"""
1820
# create an instance of AccountRequest from a JSON string
1921
account_request_instance = AccountRequest.from_json(json)
2022
# print the JSON string representation of the object

‎docs/AccountResult.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,18 @@ Name | Type | Description | Notes
2222
```python
2323
from freeclimb.models.account_result import AccountResult
2424

25-
# TODO update the JSON string below
26-
json = "{}"
25+
json = """{
26+
"uri": "string",
27+
"dateCreated": "string",
28+
"dateUpdated": "string",
29+
"revision": 0,
30+
"accountId": "string",
31+
"apiKey": "string",
32+
"alias": "string",
33+
"label": "string",
34+
"type": "trial",
35+
"status": "closed"
36+
}"""
2737
# create an instance of AccountResult from a JSON string
2838
account_result_instance = AccountResult.from_json(json)
2939
# print the JSON string representation of the object

‎docs/AddToConference.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,19 @@ Name | Type | Description | Notes
2222
```python
2323
from freeclimb.models.add_to_conference import AddToConference
2424

25-
# TODO update the JSON string below
26-
json = "{}"
25+
json = """{
26+
"command": "AddToConference",
27+
"allowCallControl": false,
28+
"callControlSequence": "string",
29+
"callControlUrl": "https://www.example.com",
30+
"conferenceId": "string",
31+
"leaveConferenceUrl": "https://www.example.com",
32+
"listen": false,
33+
"notificationUrl": "https://www.example.com",
34+
"startConfOnEnter": false,
35+
"talk": false,
36+
"dtmfPassThrough": false
37+
}"""
2738
# create an instance of AddToConference from a JSON string
2839
add_to_conference_instance = AddToConference.from_json(json)
2940
# print the JSON string representation of the object

‎docs/AddToConferenceNotificationWebhook.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,21 @@ Name | Type | Description | Notes
2525
```python
2626
from freeclimb.models.add_to_conference_notification_webhook import AddToConferenceNotificationWebhook
2727

28-
# TODO update the JSON string below
29-
json = "{}"
28+
json = """{
29+
"requestType": "addToConferenceNotification",
30+
"callId": "string",
31+
"accountId": "string",
32+
"from": "string",
33+
"to": "string",
34+
"callStatus": "queued",
35+
"direction": "inbound",
36+
"conferenceId": "string",
37+
"queueId": "string",
38+
"status": "empty",
39+
"recordingUrl": "https://www.example.com",
40+
"recordingId": "string",
41+
"recordingDurationSec": 0
42+
}"""
3043
# create an instance of AddToConferenceNotificationWebhook from a JSON string
3144
add_to_conference_notification_webhook_instance = AddToConferenceNotificationWebhook.from_json(json)
3245
# print the JSON string representation of the object

‎docs/AddToQueueNotificationWebhook.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,17 @@ Name | Type | Description | Notes
2121
```python
2222
from freeclimb.models.add_to_queue_notification_webhook import AddToQueueNotificationWebhook
2323

24-
# TODO update the JSON string below
25-
json = "{}"
24+
json = """{
25+
"requestType": "addToQueueNotification",
26+
"callId": "string",
27+
"accountId": "string",
28+
"from": "string",
29+
"to": "string",
30+
"callStatus": "queued",
31+
"direction": "inbound",
32+
"conferenceId": "string",
33+
"queueId": "string"
34+
}"""
2635
# create an instance of AddToQueueNotificationWebhook from a JSON string
2736
add_to_queue_notification_webhook_instance = AddToQueueNotificationWebhook.from_json(json)
2837
# print the JSON string representation of the object

‎docs/ApplicationList.md‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,32 @@ Name | Type | Description | Notes
1919
```python
2020
from freeclimb.models.application_list import ApplicationList
2121

22-
# TODO update the JSON string below
23-
json = "{}"
22+
json = """{
23+
"total": 0,
24+
"start": 0,
25+
"end": 0,
26+
"page": 0,
27+
"numPages": 0,
28+
"pageSize": 0,
29+
"nextPageUri": "string",
30+
"applications": [
31+
{
32+
"uri": "string",
33+
"dateCreated": "string",
34+
"dateUpdated": "string",
35+
"revision": 0,
36+
"accountId": "string",
37+
"applicationId": "string",
38+
"alias": "string",
39+
"voiceUrl": "https://www.example.com",
40+
"voiceFallbackUrl": "https://www.example.com",
41+
"callConnectUrl": "https://www.example.com",
42+
"statusCallbackUrl": "https://www.example.com",
43+
"smsUrl": "https://www.example.com",
44+
"smsFallbackUrl": "https://www.example.com"
45+
}
46+
]
47+
}"""
2448
# create an instance of ApplicationList from a JSON string
2549
application_list_instance = ApplicationList.from_json(json)
2650
# print the JSON string representation of the object

‎docs/ApplicationRequest.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,15 @@ Name | Type | Description | Notes
1818
```python
1919
from freeclimb.models.application_request import ApplicationRequest
2020

21-
# TODO update the JSON string below
22-
json = "{}"
21+
json = """{
22+
"alias": "Customer Support Line",
23+
"voiceUrl": "https://www.myapp.com/voice",
24+
"voiceFallbackUrl": "https://www.myapp.com/voiceFallback",
25+
"callConnectUrl": "https://www.myapp.com/callConnect",
26+
"statusCallbackUrl": "https://www.myapp.com/status",
27+
"smsUrl": "https://www.myapp.com/sms",
28+
"smsFallbackUrl": "https://www.myapp.com/smsFallback"
29+
}"""
2330
# create an instance of ApplicationRequest from a JSON string
2431
application_request_instance = ApplicationRequest.from_json(json)
2532
# print the JSON string representation of the object

‎docs/ApplicationResult.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,21 @@ Name | Type | Description | Notes
2424
```python
2525
from freeclimb.models.application_result import ApplicationResult
2626

27-
# TODO update the JSON string below
28-
json = "{}"
27+
json = """{
28+
"uri": "string",
29+
"dateCreated": "string",
30+
"dateUpdated": "string",
31+
"revision": 0,
32+
"accountId": "string",
33+
"applicationId": "string",
34+
"alias": "string",
35+
"voiceUrl": "https://www.example.com",
36+
"voiceFallbackUrl": "https://www.example.com",
37+
"callConnectUrl": "https://www.example.com",
38+
"statusCallbackUrl": "https://www.example.com",
39+
"smsUrl": "https://www.example.com",
40+
"smsFallbackUrl": "https://www.example.com"
41+
}"""
2942
# create an instance of ApplicationResult from a JSON string
3043
application_result_instance = ApplicationResult.from_json(json)
3144
# print the JSON string representation of the object

‎docs/AudioStream.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,16 @@ Name | Type | Description | Notes
1717
```python
1818
from freeclimb.models.audio_stream import AudioStream
1919

20-
# TODO update the JSON string below
21-
json = "{}"
20+
json = """{
21+
"command": "AudioStream",
22+
"location": "https://www.example.com",
23+
"actionUrl": "https://www.example.com",
24+
"contentType": "string",
25+
"metaData": [
26+
"string"
27+
],
28+
"privacyMode": false
29+
}"""
2230
# create an instance of AudioStream from a JSON string
2331
audio_stream_instance = AudioStream.from_json(json)
2432
# print the JSON string representation of the object

0 commit comments

Comments
 (0)