Skip to content
Merged
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
1 change: 1 addition & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -269,4 +269,5 @@ requirements.txt
setup.cfg
setup.py
test/__init__.py
test/test_default_api.py
tox.ini
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,16 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

None

<a name="4.3.0"></a>

## [4.3.0] - 2023-04-27

### Changed

- Introduce application ID filtering for list calls method

<a name="4.2.1"></a>

## [4.2.1] - 2023-04-27

### Changed
Expand Down
372 changes: 189 additions & 183 deletions README.md

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2377,6 +2377,9 @@ with freeclimb.ApiClient(configuration) as api_client:
start_time = "startTime_example" # str | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
end_time = "endTime_example" # str | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. (optional)
parent_call_id = "parentCallId_example" # str | Only show Calls spawned by the call with this ID. (optional)
application_id = [
"AP62ECB020842930cc01FFCCfeEe150AC32DcAEc8a",
] # [str] | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. (optional)

# example passing only required values which don't have defaults set
try:
Expand All @@ -2390,7 +2393,7 @@ with freeclimb.ApiClient(configuration) as api_client:
# and optional values
try:
# List Calls
api_response = api_instance.list_calls(account_id, active=active, to=to, _from=_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id)
api_response = api_instance.list_calls(account_id, active=active, to=to, _from=_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id)
pprint(api_response)
except freeclimb.ApiException as e:
print("Exception when calling DefaultApi->list_calls: %s\n" % e)
Expand All @@ -2409,6 +2412,7 @@ Name | Type | Description | Notes
**start_time** | **str**| Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
**end_time** | **str**| Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional]
**parent_call_id** | **str**| Only show Calls spawned by the call with this ID. | [optional]
**application_id** | **[str]**| Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/PlayBeep.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PlayBeep

Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`.
Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always`
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion freeclimb/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"""


__version__ = "4.2.1"
__version__ = "4.3.0"

# import ApiClient
from freeclimb.api_client import ApiClient
Expand Down
12 changes: 12 additions & 0 deletions freeclimb/api/default_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1732,6 +1732,7 @@ def __init__(self, api_client=None, account_id=None):
'start_time',
'end_time',
'parent_call_id',
'application_id',
],
'required': [
'account_id',
Expand All @@ -1741,10 +1742,15 @@ def __init__(self, api_client=None, account_id=None):
'enum': [
],
'validation': [
'application_id',
]
},
root_map={
'validations': {
('application_id',): {

'max_items': 16,
},
},
'allowed_values': {
},
Expand All @@ -1765,6 +1771,8 @@ def __init__(self, api_client=None, account_id=None):
(str,),
'parent_call_id':
(str,),
'application_id':
([str],),
},
'attribute_map': {
'account_id': 'accountId',
Expand All @@ -1775,6 +1783,7 @@ def __init__(self, api_client=None, account_id=None):
'start_time': 'startTime',
'end_time': 'endTime',
'parent_call_id': 'parentCallId',
'application_id': 'applicationId',
},
'location_map': {
'account_id': 'path',
Expand All @@ -1785,8 +1794,10 @@ def __init__(self, api_client=None, account_id=None):
'start_time': 'query',
'end_time': 'query',
'parent_call_id': 'query',
'application_id': 'query',
},
'collection_format_map': {
'application_id': 'multi',
}
},
headers_map={
Expand Down Expand Up @@ -5360,6 +5371,7 @@ def list_calls(
start_time (str): Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.. [optional]
end_time (str): Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.. [optional]
parent_call_id (str): Only show Calls spawned by the call with this ID.. [optional]
application_id ([str]): Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
Expand Down
2 changes: 1 addition & 1 deletion freeclimb/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = 'OpenAPI-Generator/4.2.1/python'
self.user_agent = 'OpenAPI-Generator/4.3.0/python'

def __enter__(self):
return self
Expand Down
2 changes: 1 addition & 1 deletion freeclimb/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ def to_debug_report(self):
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 1.0.0\n"\
"SDK Package Version: 4.2.1".\
"SDK Package Version: 4.3.0".\
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
Expand Down
63 changes: 38 additions & 25 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,28 +85,33 @@
"type": "string",
"enum": ["closed", "suspended", "active"],
"x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
"description": "The status of this account. It is one of: active, suspended, or closed."
"description": "The status of this account. It is one of: active, suspended, or closed.",
"nullable": true
},
"AccountType": {
"type": "string",
"description": "The type of this account. It is one of: trial or full.",
"enum": ["trial", "full"],
"x-enum-varnames": ["TRIAL", "FULL"]
"x-enum-varnames": ["TRIAL", "FULL"],
"nullable": true
},
"AnsweredBy": {
"type": "string",
"nullable": true,
"enum": ["human", "machine"],
"x-enum-varnames": ["HUMAN", "MACHINE"],
"description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
},
"CallDirection": {
"type": "string",
"nullable": true,
"enum": ["inbound", "outboundAPI", "outboundDial"],
"x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
"description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command."
},
"CallStatus": {
"type": "string",
"nullable": true,
"enum": [
"queued",
"ringing",
Expand All @@ -131,6 +136,7 @@
},
"ConferenceStatus": {
"type": "string",
"nullable": true,
"enum": ["empty", "populated", "inProgress", "terminated"],
"x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
"description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
Expand Down Expand Up @@ -194,6 +200,7 @@
"GrammarType": {
"type": "string",
"enum": ["URL", "BUILTIN"],
"nullable": true,
"x-enum-varnames": ["URL", "BUILT_IN"],
"description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
},
Expand Down Expand Up @@ -265,6 +272,7 @@
"LogLevel": {
"type": "string",
"enum": ["info", "warning", "error"],
"nullable": true,
"x-enum-varnames": ["INFO", "WARNING", "ERROR"],
"description": "Level of the log. Possible values are info, warning, and error."
},
Expand All @@ -280,6 +288,7 @@
},
"MessageStatus": {
"type": "string",
"nullable": true,
"description": "Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown",
"enum": [
"new",
Expand Down Expand Up @@ -310,9 +319,10 @@
},
"PlayBeep": {
"type": "string",
"nullable": true,
"enum": ["always", "never", "entryOnly", "exitOnly"],
"x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
"description": "Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`.",
"description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
"default": "always",
"x-enum-default-attr": "ALWAYS"
},
Expand Down Expand Up @@ -520,7 +530,6 @@
"type": "boolean"
},
"playBeep": {
"description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
"$ref": "#/components/schemas/PlayBeep"
},
"record": {
Expand Down Expand Up @@ -653,8 +662,7 @@
"format": "uri"
},
"grammarType": {
"$ref": "#/components/schemas/GrammarType",
"nullable": true
"$ref": "#/components/schemas/GrammarType"
},
"grammarFile": {
"description": "The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL.",
Expand Down Expand Up @@ -1297,12 +1305,10 @@
"nullable": true
},
"type": {
"$ref": "#/components/schemas/AccountType",
"nullable": true
"$ref": "#/components/schemas/AccountType"
},
"status": {
"$ref": "#/components/schemas/AccountStatus",
"nullable": true
"$ref": "#/components/schemas/AccountStatus"
},
"subresourceUris": {
"type": "object",
Expand Down Expand Up @@ -1648,8 +1654,7 @@
"nullable": true
},
"callStatus": {
"$ref": "#/components/schemas/CallStatus",
"nullable": true
"$ref": "#/components/schemas/CallStatus"
},
"startTime": {
"type": "string",
Expand Down Expand Up @@ -1677,12 +1682,10 @@
"nullable": true
},
"direction": {
"$ref": "#/components/schemas/CallDirection",
"nullable": true
"$ref": "#/components/schemas/CallDirection"
},
"answeredBy": {
"$ref": "#/components/schemas/AnsweredBy",
"nullable": true
"$ref": "#/components/schemas/AnsweredBy"
},
"subresourceUris": {
"type": "object",
Expand Down Expand Up @@ -1834,9 +1837,7 @@
"nullable": true
},
"level": {
"$ref": "#/components/schemas/LogLevel",

"nullable": true
"$ref": "#/components/schemas/LogLevel"
},
"requestId": {
"type": "string",
Expand Down Expand Up @@ -1909,17 +1910,15 @@
},
"playBeep": {
"$ref": "#/components/schemas/PlayBeep",
"description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always.",
"nullable": true
"description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always."
},
"record": {
"type": "boolean",
"description": "Flag indicating whether recording is enabled for this Conference.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/ConferenceStatus",
"nullable": true
"$ref": "#/components/schemas/ConferenceStatus"
},
"waitUrl": {
"type": "string",
Expand Down Expand Up @@ -2036,8 +2035,7 @@
"nullable": true
},
"status": {
"$ref": "#/components/schemas/MessageStatus",
"nullable": true
"$ref": "#/components/schemas/MessageStatus"
},
"from": {
"type": "string",
Expand Down Expand Up @@ -3066,6 +3064,21 @@
"type": "string"
}
},
{
"name": "applicationId",
"in": "query",
"description": "Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.",
"explode": true,
"required": false,
"schema": {
"type": "array",
"maxItems": 16,
"items": {
"type": "string",
"pattern": "^AP[0-9a-fA-F]{40}$"
}
}
},
{
"$ref": "#/components/parameters/AccountId"
}
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from setuptools import setup, find_packages # noqa: H301

NAME = "FreeClimb"
VERSION = "4.2.1"
VERSION = "4.3.0"
# To install the library, run the following
#
# python setup.py install
Expand Down
5 changes: 4 additions & 1 deletion test/test_default_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -498,9 +498,10 @@ def test_list_calls(self):
start_time = start_time_list_calls_test_value
end_time = end_time_list_calls_test_value
parent_call_id = parent_call_id_list_calls_test_value
application_id = application_id_list_calls_test_value


api_response = self.api.list_calls(active=active,to=to,_from=_from,status=status,start_time=start_time,end_time=end_time,parent_call_id=parent_call_id)
api_response = self.api.list_calls(active=active,to=to,_from=_from,status=status,start_time=start_time,end_time=end_time,parent_call_id=parent_call_id,application_id=application_id)

assert isinstance(api_response, CallList)

Expand Down Expand Up @@ -873,6 +874,8 @@ def test_update_an_incoming_number(self):

parent_call_id_list_calls_test_value = "parentCallId_example"

application_id_list_calls_test_value = ['AP0123456789ABCDEFabcedf000000000000000001','AP0123456789ABCDEFabcedf000000000000000002', 'AP0123456789ABCDEFabcedf000000000000000003']

status_list_conferences_test_value = "status_example"

alias_list_conferences_test_value = "alias_example"
Expand Down