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
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ docs/Say.md
docs/SayAllOf.md
docs/SendDigits.md
docs/SendDigitsAllOf.md
docs/SetDTMFPassThrough.md
docs/SetDTMFPassThroughAllOf.md
docs/SetListen.md
docs/SetListenAllOf.md
docs/SetTalk.md
Expand Down Expand Up @@ -267,6 +269,8 @@ freeclimb/model/say.py
freeclimb/model/say_all_of.py
freeclimb/model/send_digits.py
freeclimb/model/send_digits_all_of.py
freeclimb/model/set_dtmf_pass_through.py
freeclimb/model/set_dtmf_pass_through_all_of.py
freeclimb/model/set_listen.py
freeclimb/model/set_listen_all_of.py
freeclimb/model/set_talk.py
Expand Down Expand Up @@ -305,4 +309,6 @@ requirements.txt
setup.cfg
setup.py
test/__init__.py
test/test_set_dtmf_pass_through.py
test/test_set_dtmf_pass_through_all_of.py
tox.ini
4 changes: 3 additions & 1 deletion 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: 4.8.0
- Package version: 4.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 @@ -315,6 +315,8 @@ Class | Method | HTTP request | Description
- [SayAllOf](docs/SayAllOf.md)
- [SendDigits](docs/SendDigits.md)
- [SendDigitsAllOf](docs/SendDigitsAllOf.md)
- [SetDTMFPassThrough](docs/SetDTMFPassThrough.md)
- [SetDTMFPassThroughAllOf](docs/SetDTMFPassThroughAllOf.md)
- [SetListen](docs/SetListen.md)
- [SetListenAllOf](docs/SetListenAllOf.md)
- [SetTalk](docs/SetTalk.md)
Expand Down
1 change: 1 addition & 0 deletions docs/AddToConference.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**notification_url** | **str** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
**start_conf_on_enter** | **bool** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
**talk** | **bool** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
**dtmf_pass_through** | **bool** | If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command. | [optional]
**command** | **str** | Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/AddToConferenceAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**notification_url** | **str** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
**start_conf_on_enter** | **bool** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
**talk** | **bool** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
**dtmf_pass_through** | **bool** | If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/CallResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**direction** | [**CallDirection**](CallDirection.md) | | [optional]
**answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional]
**subresource_uris** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional]
**application_id** | **str, none_type** | ApplicationId associated with the Call. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/CallResultAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Name | Type | Description | Notes
**direction** | [**CallDirection**](CallDirection.md) | | [optional]
**answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional]
**subresource_uris** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional]
**application_id** | **str, none_type** | ApplicationId associated with the Call. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/ConferenceParticipantResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**call_id** | **str, none_type** | ID of the Call associated with this Participant. | [optional]
**talk** | **bool, none_type** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
**listen** | **bool, none_type** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
**dtmf_pass_through** | **bool, none_type** | True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise. | [optional]
**start_conf_on_enter** | **bool, none_type** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/ConferenceParticipantResultAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**call_id** | **str, none_type** | ID of the Call associated with this Participant. | [optional]
**talk** | **bool, none_type** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
**listen** | **bool, none_type** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
**dtmf_pass_through** | **bool, none_type** | True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise. | [optional]
**start_conf_on_enter** | **bool, none_type** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
5 changes: 4 additions & 1 deletion docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3555,6 +3555,7 @@ with freeclimb.ApiClient(configuration) as api_client:
conference_id = "conferenceId_example" # str | ID of the conference this participant is in.
talk = True # bool | Only show Participants with the talk privilege. (optional)
listen = True # bool | Only show Participants with the listen privilege. (optional)
dtmf_pass_through = True # bool | Only show Participants with the dtmfPassThrough privilege. (optional)

# example passing only required values which don't have defaults set
try:
Expand All @@ -3568,7 +3569,7 @@ with freeclimb.ApiClient(configuration) as api_client:
# and optional values
try:
# List Participants
api_response = api_instance.list_participants(conference_id, talk=talk, listen=listen)
api_response = api_instance.list_participants(conference_id, talk=talk, listen=listen, dtmf_pass_through=dtmf_pass_through)
pprint(api_response)
except freeclimb.ApiException as e:
print("Exception when calling DefaultApi->list_participants: %s\n" % e)
Expand All @@ -3582,6 +3583,7 @@ Name | Type | Description | Notes
**conference_id** | **str**| ID of the conference this participant is in. |
**talk** | **bool**| Only show Participants with the talk privilege. | [optional]
**listen** | **bool**| Only show Participants with the listen privilege. | [optional]
**dtmf_pass_through** | **bool**| Only show Participants with the dtmfPassThrough privilege. | [optional]

### Return type

Expand Down Expand Up @@ -4419,6 +4421,7 @@ with freeclimb.ApiClient(configuration) as api_client:
update_conference_participant_request = UpdateConferenceParticipantRequest(
talk=True,
listen=True,
dtmf_pass_through=True,
) # UpdateConferenceParticipantRequest | Conference participant details to update (optional)

# example passing only required values which don't have defaults set
Expand Down
2 changes: 1 addition & 1 deletion docs/MessageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
**notification_url** | **str** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
**media_urls** | **[str]** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional]
**media_urls** | **[str], none_type** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/MessageRequestAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**to** | **str** | Phone number to receive the message. Must be within FreeClimb's service area. |
**text** | **str** | Text contained in the message (maximum 160 characters). **Note:** For text, only ASCII characters are supported. |
**notification_url** | **str** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored. | [optional]
**media_urls** | **[str]** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional]
**media_urls** | **[str], none_type** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/MessageResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**brand_id** | **str, none_type** | The unique identifier for the brand associated with the message | [optional]
**campaign_id** | **str, none_type** | The unique identifier for the campaign associated with the message | [optional]
**segment_count** | **float, none_type** | The number of segments into which the message was split | [optional]
**media_urls** | **[str]** | an array of HTTP URLs which were attached this this message | [optional]
**media_urls** | **[str], none_type** | an array of HTTP URLs which were attached this this message | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/MessageResultAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**brand_id** | **str, none_type** | The unique identifier for the brand associated with the message | [optional]
**campaign_id** | **str, none_type** | The unique identifier for the campaign associated with the message | [optional]
**segment_count** | **float, none_type** | The number of segments into which the message was split | [optional]
**media_urls** | **[str]** | an array of HTTP URLs which were attached this this message | [optional]
**media_urls** | **[str], none_type** | an array of HTTP URLs which were attached this this message | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

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

The `SetDTMFPassThrough` command enables or disables the dtmfPassThrough privilege for this Conference Participant. If 'true', DTMFs will be passed through from this Participant to all other Participants in the Conference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dtmf_pass_through** | **bool** | Specifying `false` mutes the Participant's dtmf audio. | [optional]
**command** | **str** | Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments) | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/SetDTMFPassThroughAllOf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SetDTMFPassThroughAllOf

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dtmf_pass_through** | **bool** | Specifying `false` mutes the Participant's dtmf audio. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


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

The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference. The Participant can hear what the other participants are saying only if this privilege is enabled.
The `SetListen` command enables or disables the listen privilege for this Conference Participant. The Participant can hear what the other participants are saying only if this privilege is enabled.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
2 changes: 1 addition & 1 deletion docs/SetTalk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SetTalk

The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference. If 'true', no audio from that Participant is shared with the other Participants of the Conference.
The `SetTalk` command enables or disables the talk privilege for this Conference Participant. If 'true', no audio from that Participant is shared with the other Participants of the Conference.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
1 change: 1 addition & 0 deletions docs/UpdateConferenceParticipantRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**talk** | **bool** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional]
**listen** | **bool** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional]
**dtmf_pass_through** | **bool** | (Optional) Default is `true`. Setting to `false` mutes dtmf audio for this Participant. FreeClimb returns an error and ignores any other value. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 3 additions & 1 deletion freeclimb/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"""


__version__ = "4.8.0"
__version__ = "4.9.0"

# import ApiClient
from freeclimb.api_client import ApiClient
Expand Down Expand Up @@ -157,6 +157,8 @@
from freeclimb.model.say_all_of import SayAllOf
from freeclimb.model.send_digits import SendDigits
from freeclimb.model.send_digits_all_of import SendDigitsAllOf
from freeclimb.model.set_dtmf_pass_through import SetDTMFPassThrough
from freeclimb.model.set_dtmf_pass_through_all_of import SetDTMFPassThroughAllOf
from freeclimb.model.set_listen import SetListen
from freeclimb.model.set_listen_all_of import SetListenAllOf
from freeclimb.model.set_talk import SetTalk
Expand Down
6 changes: 6 additions & 0 deletions freeclimb/api/default_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -2667,6 +2667,7 @@ def __init__(self, api_client=None, account_id=None):
'conference_id',
'talk',
'listen',
'dtmf_pass_through',
],
'required': [
'account_id',
Expand All @@ -2693,18 +2694,22 @@ def __init__(self, api_client=None, account_id=None):
(bool,),
'listen':
(bool,),
'dtmf_pass_through':
(bool,),
},
'attribute_map': {
'account_id': 'accountId',
'conference_id': 'conferenceId',
'talk': 'talk',
'listen': 'listen',
'dtmf_pass_through': 'dtmfPassThrough',
},
'location_map': {
'account_id': 'path',
'conference_id': 'path',
'talk': 'query',
'listen': 'query',
'dtmf_pass_through': 'query',
},
'collection_format_map': {
}
Expand Down Expand Up @@ -7229,6 +7234,7 @@ def list_participants(
Keyword Args:
talk (bool): Only show Participants with the talk privilege.. [optional]
listen (bool): Only show Participants with the listen privilege.. [optional]
dtmf_pass_through (bool): Only show Participants with the dtmfPassThrough privilege.. [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.8.0/python'
self.user_agent = 'OpenAPI-Generator/4.9.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.8.0".\
"SDK Package Version: 4.9.0".\
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
Expand Down
Loading
Loading