Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename zang #4

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (C) 2012, Zang, Inc. <support(at)zang(dot)io>
Copyright (C) 2020, Avaya Cloud Inc. <support(at)zang(dot)io>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
20 changes: 10 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ zang-python
==========

This python package is an open source tool built to simplify interaction with
the `Zang <http://www.zang.io>`_ telephony platform. Zang makes adding voice
the `Avaya CPaaS <http://www.zang.io>`_ telephony platform. Avaya CPaaS makes adding voice
and SMS to applications fun and easy.

For more information about Zang, please visit:
`Zang Cloud <https://www.zang.io/products/cloud>`_
For more information about Avaya CPaaS, please visit:
`Avaya OneCloud™️ CPaaS <https://www.zang.io/products/cloud>`

To read the official documentation, please visit: `Zang Docs <http://docs.zang.io/aspx/docs>`_.
To read the official documentation, please visit: `Avaya CPaaS Docs <http://docs.zang.io/aspx/docs>`_.


Installation
Expand All @@ -30,7 +30,7 @@ Usage
REST
----

See the `Zang REST API documentation <http://docs.zang.io/aspx/rest>`_
See the `Avaya CPaaS REST API documentation <http://docs.zang.io/aspx/rest>`_
for more information.

Send SMS Example
Expand All @@ -52,7 +52,7 @@ Send SMS Example
try:
smsMessage = smsMessagesConnector.sendSmsMessage(
to='(XXX) XXX-XXXX',
body='Hello from Zang!',
body='Hello from Avaya CPaaS!',
from_='(XXX) XXX-XXXX')
print(smsMessage)
except ZangException as ze:
Expand All @@ -65,7 +65,7 @@ Configuration

First a configuration object must be created by using ``Configuration`` class.

Normally you'll want to just enter your Zang Platform Account ``sid``
Normally you'll want to just enter your Avaya CPaaS Platform Account ``sid``
and ``authToken``, but you can also define a base API URL.

Next you'll have to create a connector by using ``ConnectorFactory``.
Expand Down Expand Up @@ -146,7 +146,7 @@ InboundXML
==========

InboundXML is an XML dialect which enables you to control phone call flow.
For more information please visit the `Zang InboundXML documentation
For more information please visit the `Avaya CPaaS InboundXML documentation
<http://docs.zang.io/aspx/inboundxml>`_.

<Say> Example
Expand All @@ -159,7 +159,7 @@ For more information please visit the `Zang InboundXML documentation
# enums
from zang.inboundxml import Voice, Language

say = Say("Welcome to Zang!",
say = Say("Welcome to Avaya CPaaS!",
language=Language.EN,
voice=Voice.FEMALE,
loop=3)
Expand All @@ -177,7 +177,7 @@ will render

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
<Say loop="3" voice="female" language="en">Welcome to Zang!</Say>
<Say loop="3" voice="female" language="en">Welcome to Avaya CPaaS!</Say>
</Response>

.. code-block:: xml
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


setup(name="zang",
author='Zang Inc.',
author='Avaya Cloud Inc.',
author_email='support@zang.io',
classifiers=[
'Development Status :: 4 - Beta',
Expand All @@ -22,7 +22,7 @@
'Programming Language :: Python :: 3.6',
'Topic :: Utilities'],
description=('This Python pacakge is an open source tool built to '
'simplify interaction with the Zang telephony platform.'),
'simplify interaction with the Avaya CPaaS telephony platform.'),
install_requires=['enum', 'requests', 'python-dateutil'],
keywords='zang api wrapper',
license='MIT License',
Expand Down
2 changes: 1 addition & 1 deletion zang/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@

__title__ = 'zang'
__author__ = 'Zang'
__copyright__ = 'Copyright 2017 Zang'
__copyright__ = 'Copyright 2020 Avaya Cloud Inc'
__license__ = 'MIT'

__version__ = '1.0.0'
2 changes: 1 addition & 1 deletion zang/connectors/accounts_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
class AccountsConnector(BaseConnector):
"""
Used for all forms of communication with the `Application Clients`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/application_clients_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class ApplicationClientsConnector(BaseConnector):

"""
Used for all forms of communication with the `Application Clients` endpoint
of the Zang REST API.
of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/available_phone_numbers_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class AvailablePhoneNumbersConnector(BaseConnector):
"""
Used for all forms of communication with the `AvailablePhoneNumbers`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/base_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
zang.connectors.base_connector
~~~~~~~~~~~~~~~~~~~
This module contains base connector class used for all forms of communication
with the Zang REST API.
with the Avaya CPaaS REST API.
"""


Expand Down
6 changes: 3 additions & 3 deletions zang/connectors/calls_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
class CallsConnector(BaseConnector):
"""
Used for all forms of communication with the `Calls`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down Expand Up @@ -192,13 +192,13 @@ def makeCall(
should be sent straight to the user's voicemail. Allowed positive
values are "true" and "True" - any other value will default to
"false".
:param ifMachine: (optional)Specifies how Zang should handle this
:param ifMachine: (optional)Specifies how Avaya CPaaS should handle this
call if it goes to voicemail. Allowed values are "continue" to
proceed as normal, "redirect" to redirect the call to the
ifMachineUrl, or "hangup" to hang up the call. Hangup occurs when
the tone is played. IfMachine accuracy is around 90% and may not
work in all countries.
:param ifMachineUrl: (optional)The URL Zang will redirect to for
:param ifMachineUrl: (optional)The URL Avaya CPaaS will redirect to for
instructions if a voicemail machine is detected while the
IfMachine parameter is set to "redirect". Url length is
limited to 200 characters.
Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/carrier_services_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
class CarrierServicesConnector(BaseConnector):
"""
Used for all forms of communication with the `Lookups`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/conferences_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
class ConferencesConnector(BaseConnector):
"""
Used for all forms of communication with the `Conferences`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/connector_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@


class ConnectorFactory(object):
"""The main Zang class."""
"""The main Avaya CPaaS class."""

def __init__(self, configuration=None, session=None):
self.executor = Executor(session=session, configuration=configuration)
Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/fraud_control_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class FraudControlConnector(BaseConnector):
"""
Used for all forms of communication with the `FraudControlConnector`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/incoming_phone_numbers_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class IncomingPhoneNumbersConnector(BaseConnector):
"""
Used for all forms of communication with the `Incoming Phone Numbers`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/ip_access_control_lists_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
class IpAccessControlListsConnector(BaseConnector):
"""
Used for all forms of communication with the `IpAccessControlLists`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
4 changes: 2 additions & 2 deletions zang/connectors/mms_messages_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
class MmsMessagesConnector(BaseConnector):
"""
Used for all forms of communication with the `MMS/Messages`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand All @@ -36,7 +36,7 @@ def sendMmsMessage(
to be in any specific format.
:param mediaUrl: URL of an image to be sent.
:param body: Text of the MMS to be sent.
:param from_: Must be a Zang number associated with your account.
:param from_: Must be a Avaya CPaaS number associated with your account.
The value does not have to be in any specific format.
:param statusCallback: The URL that will be sent information about
the MMS. Url length is limited to 200 characters.
Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/notifications_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
class NotificationsConnector(BaseConnector):
"""
Used for all forms of communication with the `Notifications`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
4 changes: 2 additions & 2 deletions zang/connectors/recordings_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class RecordingsConnector(BaseConnector):
"""
Used for all forms of communication with the `Recordings`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down Expand Up @@ -87,7 +87,7 @@ def recordCall(
transcribeQuality=None,
transcribeCallback=None,):
"""
Records a Zang call
Records a Avaya CPaaS call

:param callSid: Call SID.
:param record: Specifies if a call recording should start or end.
Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/sip_credentials_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class SipCredentialsConnector(BaseConnector):
"""
Used for all forms of communication with the `SIP Credentials` endpoint
of the Zang REST API.
of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
4 changes: 2 additions & 2 deletions zang/connectors/sip_domains_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
~~~~~~~~~~~~

Used for all forms of communication with the Sip Domains endpoint of the
Zang REST API.
Avaya CPaaS REST API.
see ConnectorFactory
"""
from zang.connectors.base_connector import BaseConnector
Expand All @@ -24,7 +24,7 @@
class SipDomainsConnector(BaseConnector):
"""
Used for all forms of communication with the `SIP Domains` endpoint
of the Zang REST API.
of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
8 changes: 4 additions & 4 deletions zang/connectors/sms_messages_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
class SmsMessagesConnector(BaseConnector):
"""
Used for all forms of communication with the `SMS/Messages`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand All @@ -24,7 +24,7 @@ def __init__(self, executor):

def viewSmsMessage(self, smsMessageSid):
"""
Text messages sent to and from Zang phone numbers are represented with.
Text messages sent to and from Avaya CPaaS phone numbers are represented with.

:param smsMessageSid:
:type smsMessageSid: str
Expand All @@ -46,7 +46,7 @@ def listSmsMessages(
page=None,
pageSize=None):
"""
Text messages sent to and from Zang phone numbers are represented with.
Text messages sent to and from Avaya CPaaS phone numbers are represented with.

:param to: (optional) Lists all SMS messages sent to this number.
:param from_: (optional) Lists all SMS messages sent from this number.
Expand Down Expand Up @@ -93,7 +93,7 @@ def sendSmsMessage(
:param to: Must be an SMS capable number. The value does not have
to be in any specific format.
:param body: Text of the SMS to be sent.
:param from_: Must be a Zang number associated with your account.
:param from_: Must be a Avaya CPaaS number associated with your account.
The value does not have to be in any specific format.
:param statusCallback: The URL that will be sent information about
the SMS. Url length is limited to 200 characters.
Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/transcriptions_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class TranscriptionsConnector(BaseConnector):
"""
Used for all forms of communication with the `Transcriptions`
endpoint of the Zang REST API.
endpoint of the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down
2 changes: 1 addition & 1 deletion zang/connectors/usages_connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class UsagesConnector(BaseConnector):
"""
Used for all forms of communication with the `Usages` endpoint of
the Zang REST API.
the Avaya CPaaS REST API.
.. seealso:: zang.connectors.connector_factory.ConnectorFactory
"""

Expand Down