# Namespace Catapult

## Classes summary

Account | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
AnswerCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
Application | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
ApplicationCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
AudioMixin | Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio
BaML |
BaMLAssert |
BaMLAttribute |
BaMLContainer |
BaMLGather |
BaMLGeneric |
BaMLHangup |
BaMLPlayAudio |
BaMLRedirect |
BaMLResource |
BaMLSendMessage |
BaMLSpeakSentence |
BaMLText |
BaMLTransfer |
BaMLVerb |
BaMLVerbGather |
BaMLVerbHangup |
BaMLVerbPlayAudio |
BaMLVerbRecord |
BaMLVerbRedirect |
BaMLVerbSendMessage |
BaMLVerbSpeakSentence |
BaMLVerbTransfer |
BaseResource | Provides the base for helper resources.
BaseUtilities | Base functions for dealing with responses, headers content and internal type handling
Bridge | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
BridgeCollection | Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio
Call | Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio
Callback | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
CallCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
CallCombo |
CallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
CallEvents | Note: Important keep name consistent with API. These can be easily confused for 'Event'. There is a property in genericResource that will switch to this whenever looking for a subclass. i.e being called directly from class Call
CallEventsCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
Cleaner | Base functions for dealing with responses, headers content and internal type handling
Client | RESTful client for Bandwidth. These contain components for all HTTP requests made with Bandwidth.
ClientResource | Client resource has one function it attaches the main client to this model, by reference outcome should be all objects pointing to the same client
CollectionIterator | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
CollectionObject | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
CollectionSequence | provide functions for last/1 and first/1 in a collection subset so example: $calls->find(array("direction" => "in", "state" => "started"))->first()
Conference | Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio
ConferenceEventMixin | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
ConferenceMember | Audio mixin support through Bandwidth.com Catapult API. This should provide functions to stop, start, and playing given audio
ConferenceMemberEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
ConferencePlaybackEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
Constructor | Forms a new object by both modifiying new object given context by first passing it data to its internal method objects MUST have a set_up, set or setup method 'Borrowed' from Python version this should also keep things neat by switching the 'current' objects state
Converter | Set of functions to convert Catapult functions to and from native PHP objects, arrays, etc
Credentials | Get and set the credential in the JSON file if we cant find credentials.json
CredentialsUser | Object based credentials object. Use in place of JSON file if needed. Provide seamless crossover from json object
DataPacket | Represent a of GenericOptions packed as an array each datapacket should have its Schema which is followed and used through the get/add/val methods
DataPacketCollection |
Date | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
DependsObject | object for dependancies in models. Used with DependsResource
DependsResource | Depends resource, these distinguish whats needed for a model primarly used for building paths and finding out whether to create or get a model on initialization each model should have this embedded
Domains | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
DomainsCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
DTMF | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
DtmfCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
Endpoints | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
EndpointsCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
EndpointsCredentials |
EndpointsMulti | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
EndpointsToken |
Ensure | EnsureResource called before dispatching of datapackets. Make sure all parameters are of correct type. where types can be:
EnsureResource | EnsureResource called before dispatching of datapackets. Make sure all parameters are of correct type. where types can be:
ErrorCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
Event | Primary event object. All events should provide its basic methods. Moreover be initialized by it.
EventAssert | Primary event object. All events should provide its basic methods. Moreover be initialized by it.
EventCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
EventResource | EventResource. This should include all the information for each event type and how to form its model
EventType | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
FileHandler | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
Gather | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
GatherCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
GatherCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
GenericResource | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
HangupCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
Id | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
IncomingCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
LoadsResource | Loads resource will figure out what's needed for the object on load. Also how to load the object
Locator | Helpers for the response provide convinience functions to search headers, body, code for needed information locator should check Location: for a url
Log | Built in logger for Catapult SDK will be used on exceptions, folders generated relative to working directory.
Media | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
MediaCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
MediaURL | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
Message | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
MessageCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
MessageEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
MessageMulti | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
MetaResource | All these are used directly by the models they are passed in the constructors and validate, and make the models. Order of execution follows DependsResource, LoadsResource, SchemaResource, SubFunctionResource (optional)
Multi | General purpose carrying of multiple parameter objects for Schema, Depends objects
NumberInfo | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
Page | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
Parameters | convinience function for parameters. Serialize into DataPacket on addition Usage like: $params = new Catapult\Parameters(); $params->setParam1("val"); $params->setParam2("val");
PathResource | Path resource will build paths for objects and figure out which ids they need in their paths. usage follows:
PhoneCombo | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
PhoneNumber | Standard Phone Number Validation. Numbers need to be in E.164 format
PhoneNumbers | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
PhoneNumbersCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
PlaybackCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
PrototypeUtility | Quick prototypes for RESTClient allow get/create/update/patch to be mocked and dynamically defined
Recording | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
RecordingCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
RecordingCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
RejectCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
RemoveResource | remove properties when done with computation needed in certain areas
Resolver | Resolve take a set of arguments and figures out what to do with it. In other words if we have an id in the parameters call get/1. Conversly no id, call create/1 if no data is provided simply exit.
ResolverResource | Resolve take a set of arguments and figures out what to do with it. In other words if we have an id in the parameters call get/1. Conversly no id, call create/1 if no data is provided simply exit.
RESTClient |
SchemaResource | Create the keys and values for Catapult objects all these should be accessible within the model calling SchemaResource SchemaResource should be directly used with VerifyResource these are client side checks on whether input is valid
Sentence | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
SIP | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
SIPRealm | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
Size | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
SpeakCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
StringifyResource | Represent object in string form. Where form must be compilant of: (CLASS)(op1,op2..op)
SubfunctionObject | General purpose carrying of multiple parameter objects for Schema, Depends objects
SubFunctionResource | subfunction resource will register functions that are derived from another object i.e in calls: getTranscriptions this will be however defined in calls.
TextMessage | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
Timeout | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
TimeoutCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
TitleUtility | functions to pluralize and singularize catapult meta, model and terms. all these should use the actual terms before
Transaction | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
TransactionCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
Transcription | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
TranscriptionCallEvent | A generic to handle all event types. Afterwards it should initiate the type specified in datapacket
TranscriptionCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
Types | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
URIResource | Generate a resource location for Catapult. Either initialize as object or accessible by one time command: Make/2
UserError | GenericResource is the class every model should use for initialization. It provides the functions to check the mandatory, optional arguments provided
UserErrorCollection | A collection object. All collection classes must inherit this. It provides methods to lookup, serialize and put contents in a collection. Collections can represent any extended class where any of those listed in models. does not have an implemention for @class Media
VerifyResource | Provides a class for objects to verify their schema. this needs SchemaResource, An object and ensured input, a
Voice | types are a set of client side helpers to ease the integration of warnings, exceptions in a application. Unless specified these should merely serialize into a string with __toString
XMLUtility | Base functions for dealing with responses, headers content and internal type handling

## Interfaces summary

API |
API_MODE | runtime settings for debug / production release *
BAML_SETTINGS |
BAML_VERBS | BAML definitions *
BAML_XML_HANDLERS |
BAML_XML_METHODS |
BAML_XML_OPTIONS |
CALL_ERROR |
CALL_STATES |
CONFERENCE_MEMBER_STATES |
CONFERENCE_SPEAK_STATES |
CONFERENCE_STATES |
DEFAULTS | defaults used in place of custom parameters *
EXCEPTIONS |
GATHER_REASONS |
GATHER_STATES |
MESSAGE_DIRECTIONS |
MESSAGE_STATES |
NUMBER_STATES |
PATHS | paths for api endpoints *
PLAYBACK_STATES |
RECORDING_STATES |
RECORDING_STATUSES |
SPEAK_STATES |
TRANSCRIPTION_STATES |
WARNINGS |