Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ docs/CallDirection.md
docs/CallEndedReason.md
docs/CallList.md
docs/CallResult.md
docs/CallResultAllOfSubresourceUris.md
docs/CallStatus.md
docs/CallStatusWebhook.md
docs/Capabilities.md
Expand Down Expand Up @@ -187,6 +188,7 @@ freeclimb/models/call_direction.py
freeclimb/models/call_ended_reason.py
freeclimb/models/call_list.py
freeclimb/models/call_result.py
freeclimb/models/call_result_all_of_subresource_uris.py
freeclimb/models/call_status.py
freeclimb/models/call_status_webhook.py
freeclimb/models/capabilities.py
Expand Down Expand Up @@ -350,6 +352,7 @@ test/test_call_direction.py
test/test_call_ended_reason.py
test/test_call_list.py
test/test_call_result.py
test/test_call_result_all_of_subresource_uris.py
test/test_call_status.py
test/test_call_status_webhook.py
test/test_capabilities.py
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

None

<a name="5.3.1"></a>

## [5.3.1] - 2026-03-04

### Added

- New parameters for fetching recordings (start time and end time)
- Audio Streaming feature

<a name="5.3.0"></a>

## [5.3.0] - 2025-10-27
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 5.3.0
- Package version: 5.3.1
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
Expand Down Expand Up @@ -210,6 +210,7 @@ Class | Method | HTTP request | Description
- [CallEndedReason](docs/CallEndedReason.md)
- [CallList](docs/CallList.md)
- [CallResult](docs/CallResult.md)
- [CallResultAllOfSubresourceUris](docs/CallResultAllOfSubresourceUris.md)
- [CallStatus](docs/CallStatus.md)
- [CallStatusWebhook](docs/CallStatusWebhook.md)
- [Capabilities](docs/Capabilities.md)
Expand Down Expand Up @@ -389,4 +390,3 @@ Authentication schemes defined for the API:

support@freeclimb.com


1 change: 1 addition & 0 deletions docs/AvailableNumber.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**capabilities** | [**Capabilities**](Capabilities.md) | | [optional]
**campaign_id** | **str** | The campaign ID generated by the campaign registry | [optional]
**phone_number** | **str** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional]
**alias** | **str** | A nicely-formatted version of the phone number. | [optional]
**region** | **str** | The state or province of this phone number. | [optional]
**country** | **str** | The country of this phone number. | [optional]

Expand Down
10 changes: 9 additions & 1 deletion docs/CallResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Name | Type | Description | Notes
**date_created** | **str** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
**date_updated** | **str** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
**revision** | **int** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
**date_created_iso** | **datetime** | The date that this resource was created in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). | [optional]
**date_updated_iso** | **datetime** | The date that this resource was last updated in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). | [optional]
**call_id** | **str** | String that uniquely identifies this Call resource. | [optional]
**parent_call_id** | **str** | ID of the Call that created this leg (child Call). | [optional]
**account_id** | **str** | ID of the account that owns this Call. | [optional]
Expand All @@ -17,13 +19,19 @@ Name | Type | Description | Notes
**phone_number_id** | **str** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
**status** | [**CallStatus**](CallStatus.md) | | [optional]
**start_time** | **str** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
**start_time_iso** | **datetime** | Start time of the Call in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call has not yet been dialed. | [optional]
**connect_time** | **str** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
**connect_time_iso** | **datetime** | Time the Call was answered in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call has not yet been dialed. | [optional]
**end_time** | **str** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional]
**end_time_iso** | **datetime** | End time of the Call in ISO 8601 format (e.g., 2022-01-01T00:00:00.000Z). Empty if the Call did not complete successfully. | [optional]
**duration** | **int** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional]
**connect_duration** | **int** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional]
**audio_stream_duration** | **int** | Length of time that the Call used the audio stream in seconds. This value is empty or zero when the Call did not use the audio stream. | [optional]
**direction** | [**CallDirection**](CallDirection.md) | | [optional]
**answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional]
**subresource_uris** | **object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional]
**caller_name** | **str** | The caller ID name (CNAM) for this Call. Empty if unavailable. | [optional]
**web_rtc** | **bool** | Indicates whether this Call was initiated via WebRTC. | [optional]
**subresource_uris** | [**CallResultAllOfSubresourceUris**](CallResultAllOfSubresourceUris.md) | | [optional]
**application_id** | **str** | ApplicationId associated with the Call. | [optional]

## Example
Expand Down
31 changes: 31 additions & 0 deletions docs/CallResultAllOfSubresourceUris.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# CallResultAllOfSubresourceUris

The list of subresources for this Call. These include things like logs and recordings associated with the Call.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**logs** | **str** | The URI for the logs associated with this Call. | [optional]
**recordings** | **str** | The URI for the recordings associated with this Call. | [optional]

## Example

```python
from freeclimb.models.call_result_all_of_subresource_uris import CallResultAllOfSubresourceUris

# TODO update the JSON string below
json = "{}"
# create an instance of CallResultAllOfSubresourceUris from a JSON string
call_result_all_of_subresource_uris_instance = CallResultAllOfSubresourceUris.from_json(json)
# print the JSON string representation of the object
print(CallResultAllOfSubresourceUris.to_json())

# convert the object into a dict
call_result_all_of_subresource_uris_dict = call_result_all_of_subresource_uris_instance.to_dict()
# create an instance of CallResultAllOfSubresourceUris from a dict
call_result_all_of_subresource_uris_from_dict = CallResultAllOfSubresourceUris.from_dict(call_result_all_of_subresource_uris_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


34 changes: 25 additions & 9 deletions docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ Name | Type | Description | Notes

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfuly created queue | - |
**201** | Successfuly created queue | - |

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

Expand Down Expand Up @@ -3583,7 +3583,7 @@ 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)

# **list_call_recordings**
> RecordingList list_call_recordings(account_id, call_id, date_created=date_created)
> RecordingList list_call_recordings(account_id, call_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Call Recordings

Expand Down Expand Up @@ -3621,10 +3621,12 @@ with freeclimb.ApiClient(configuration) as api_client:
account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
call_id = 'call_id_example' # str | String that uniquely identifies this call resource.
date_created = 'date_created_example' # str | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. (optional)
start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

try:
# List Call Recordings
api_response = api_instance.list_call_recordings(account_id, call_id, date_created=date_created)
api_response = api_instance.list_call_recordings(account_id, call_id, date_created=date_created, start_time=start_time, end_time=end_time)
print("The response of DefaultApi->list_call_recordings:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -3641,6 +3643,8 @@ Name | Type | Description | Notes
**account_id** | **str**| ID of the account |
**call_id** | **str**| String that uniquely identifies this call resource. |
**date_created** | **str**| Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional]
**start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
**end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional]

### Return type

Expand All @@ -3664,7 +3668,7 @@ 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)

# **list_calls**
> CallList list_calls(account_id, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max)
> CallList list_calls(account_id, used_audio_stream=used_audio_stream, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max, web_rtc=web_rtc)

List Calls

Expand Down Expand Up @@ -3701,6 +3705,7 @@ with freeclimb.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = freeclimb.DefaultApi(api_client)
account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
used_audio_stream = False # bool | If usedAudioStream is set to true then all calls that have a audioStreamDuration > 0 will be returned (optional) (default to False)
active = False # bool | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (optional) (default to False)
to = 'to_example' # str | Only show Calls to this phone number. (optional)
var_from = 'var_from_example' # str | Only show Calls from this phone number. (optional)
Expand All @@ -3711,10 +3716,11 @@ with freeclimb.ApiClient(configuration) as api_client:
application_id = ['application_id_example'] # List[str] | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. (optional)
risk_score_min = 56 # int | The minimum riskScore that should be included in the list. (optional)
risk_score_max = 56 # int | The maximum riskScore that should be included in the list. (optional)
web_rtc = False # bool | Only show Calls that were originated via WebRTC. (optional) (default to False)

try:
# List Calls
api_response = api_instance.list_calls(account_id, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max)
api_response = api_instance.list_calls(account_id, used_audio_stream=used_audio_stream, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max, web_rtc=web_rtc)
print("The response of DefaultApi->list_calls:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -3729,6 +3735,7 @@ with freeclimb.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **str**| ID of the account |
**used_audio_stream** | **bool**| If usedAudioStream is set to true then all calls that have a audioStreamDuration &gt; 0 will be returned | [optional] [default to False]
**active** | **bool**| If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional] [default to False]
**to** | **str**| Only show Calls to this phone number. | [optional]
**var_from** | **str**| Only show Calls from this phone number. | [optional]
Expand All @@ -3739,6 +3746,7 @@ Name | Type | Description | Notes
**application_id** | [**List[str]**](str.md)| Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional]
**risk_score_min** | **int**| The minimum riskScore that should be included in the list. | [optional]
**risk_score_max** | **int**| The maximum riskScore that should be included in the list. | [optional]
**web_rtc** | **bool**| Only show Calls that were originated via WebRTC. | [optional] [default to False]

### Return type

Expand All @@ -3762,7 +3770,7 @@ 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)

# **list_conference_recordings**
> RecordingList list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created)
> RecordingList list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Conference Recordings

Expand Down Expand Up @@ -3801,10 +3809,12 @@ with freeclimb.ApiClient(configuration) as api_client:
conference_id = 'conference_id_example' # str | Show only Recordings made during the conference with this ID.
call_id = 'call_id_example' # str | Show only Recordings made during the Call with this ID. (optional)
date_created = 'date_created_example' # str | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

try:
# List Conference Recordings
api_response = api_instance.list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created)
api_response = api_instance.list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created, start_time=start_time, end_time=end_time)
print("The response of DefaultApi->list_conference_recordings:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -3822,6 +3832,8 @@ Name | Type | Description | Notes
**conference_id** | **str**| Show only Recordings made during the conference with this ID. |
**call_id** | **str**| Show only Recordings made during the Call with this ID. | [optional]
**date_created** | **str**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional]
**start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
**end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional]

### Return type

Expand Down Expand Up @@ -4281,7 +4293,7 @@ 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)

# **list_recordings**
> RecordingList list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created)
> RecordingList list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Recordings

Expand Down Expand Up @@ -4320,10 +4332,12 @@ with freeclimb.ApiClient(configuration) as api_client:
call_id = 'call_id_example' # str | Show only Recordings made during the Call with this ID. (optional)
conference_id = 'conference_id_example' # str | Show only Recordings made during the conference with this ID. (optional)
date_created = 'date_created_example' # str | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

try:
# List Recordings
api_response = api_instance.list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created)
api_response = api_instance.list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created, start_time=start_time, end_time=end_time)
print("The response of DefaultApi->list_recordings:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -4341,6 +4355,8 @@ Name | Type | Description | Notes
**call_id** | **str**| Show only Recordings made during the Call with this ID. | [optional]
**conference_id** | **str**| Show only Recordings made during the conference with this ID. | [optional]
**date_created** | **str**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional]
**start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
**end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/QueueResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**max_size** | **int** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional]
**current_size** | **int** | Count of Calls currently in the Queue. | [optional]
**average_queue_removal_time** | **int** | The average amount of time (in seconds) for a call to be removed from the queue. | [optional]
**average_wait_time** | **int** | The average wait time (in seconds) of all Calls in the Queue. | [optional]
**subresource_uris** | **object** | List of subresources for this Queue (which includes Queue members). | [optional]

## Example
Expand Down
Loading