| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| POST | /notifications/{notificationId}/resend |
|---|
import 'package:servicestack/servicestack.dart';
abstract class EntityInfo
{
/**
* The ID of the object
*/
// @ApiMember(Description="The ID of the object")
String? id;
/**
* The date the object was created
*/
// @ApiMember(Description="The date the object was created")
String? dateCreated;
/**
* The date the object was last modified
*/
// @ApiMember(Description="The date the object was last modified")
String? dateLastModified;
/**
* The user that created this object
*/
// @ApiMember(Description="The user that created this object")
String? createdBy;
/**
* The user that last modified this object
*/
// @ApiMember(Description="The user that last modified this object")
String? lastModifiedBy;
EntityInfo({this.id,this.dateCreated,this.dateLastModified,this.createdBy,this.lastModifiedBy});
EntityInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
dateCreated = json['dateCreated'];
dateLastModified = json['dateLastModified'];
createdBy = json['createdBy'];
lastModifiedBy = json['lastModifiedBy'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'dateCreated': dateCreated,
'dateLastModified': dateLastModified,
'createdBy': createdBy,
'lastModifiedBy': lastModifiedBy
};
getTypeName() => "EntityInfo";
TypeContext? context = _ctx;
}
class CustomerBreadcrumb implements IConvertible
{
String? id;
String? name;
CustomerBreadcrumb({this.id,this.name});
CustomerBreadcrumb.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name
};
getTypeName() => "CustomerBreadcrumb";
TypeContext? context = _ctx;
}
enum NotificationTypes
{
Email,
Sms,
Push,
IncomingCall,
OutgoingCall,
}
class NotificationRecipientInfo implements IConvertible
{
/**
* The address of the recipient
*/
// @ApiMember(Description="The address of the recipient")
String? address;
/**
* Extra info about the recipient e.g. CC, BCC
*/
// @ApiMember(Description="Extra info about the recipient e.g. CC, BCC")
String? extra;
/**
* The name of the recipient
*/
// @ApiMember(Description="The name of the recipient")
String? name;
NotificationRecipientInfo({this.address,this.extra,this.name});
NotificationRecipientInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
address = json['address'];
extra = json['extra'];
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => {
'address': address,
'extra': extra,
'name': name
};
getTypeName() => "NotificationRecipientInfo";
TypeContext? context = _ctx;
}
enum FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
class FileInfo extends EntityInfo implements IConvertible
{
/**
* The type of file this is
*/
// @ApiMember(Description="The type of file this is")
FileTypes? type;
/**
* The account ID this file is associated with
*/
// @ApiMember(Description="The account ID this file is associated with")
String? accountId;
/**
* The name of the account this file is associated with
*/
// @ApiMember(Description="The name of the account this file is associated with")
String? accountName;
/**
* The ID of the customer this file is associated with
*/
// @ApiMember(Description="The ID of the customer this file is associated with")
String? customerId;
/**
* The name of the customer this file is associated with
*/
// @ApiMember(Description="The name of the customer this file is associated with")
String? customerName;
/**
* The breadcrumb to the customer for this file
*/
// @ApiMember(Description="The breadcrumb to the customer for this file")
List<CustomerBreadcrumb>? customerBreadcrumb;
/**
* The ID of the user this file is assocaited with
*/
// @ApiMember(Description="The ID of the user this file is assocaited with")
String? userId;
/**
* The name of the user this file is associated with
*/
// @ApiMember(Description="The name of the user this file is associated with")
String? userName;
/**
* The original file name for the file
*/
// @ApiMember(Description="The original file name for the file")
String? fileName;
/**
* The URI of the file
*/
// @ApiMember(Description="The URI of the file")
String? uri;
/**
* The Content type of the file
*/
// @ApiMember(Description="The Content type of the file")
String? contentType;
/**
* The size of the file
*/
// @ApiMember(Description="The size of the file")
int? contentLength;
/**
* The Twilio ID of the recording
*/
// @ApiMember(Description="The Twilio ID of the recording")
String? recordingSid;
/**
* The duration of the recording in seconds
*/
// @ApiMember(Description="The duration of the recording in seconds")
int? recordingDuration;
/**
* Who is the recording from?
*/
// @ApiMember(Description="Who is the recording from?")
String? recordingFrom;
/**
* Transcription (if available)
*/
// @ApiMember(Description="Transcription (if available)")
String? transcription;
/**
* From Address (e.g. caller ID) for incoming calls
*/
// @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
String? fromAddress;
/**
* To Address (e.g. dialed number) for outgoing calls
*/
// @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
String? toAddress;
FileInfo({this.type,this.accountId,this.accountName,this.customerId,this.customerName,this.customerBreadcrumb,this.userId,this.userName,this.fileName,this.uri,this.contentType,this.contentLength,this.recordingSid,this.recordingDuration,this.recordingFrom,this.transcription,this.fromAddress,this.toAddress});
FileInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
type = JsonConverters.fromJson(json['type'],'FileTypes',context!);
accountId = json['accountId'];
accountName = json['accountName'];
customerId = json['customerId'];
customerName = json['customerName'];
customerBreadcrumb = JsonConverters.fromJson(json['customerBreadcrumb'],'List<CustomerBreadcrumb>',context!);
userId = json['userId'];
userName = json['userName'];
fileName = json['fileName'];
uri = json['uri'];
contentType = json['contentType'];
contentLength = json['contentLength'];
recordingSid = json['recordingSid'];
recordingDuration = json['recordingDuration'];
recordingFrom = json['recordingFrom'];
transcription = json['transcription'];
fromAddress = json['fromAddress'];
toAddress = json['toAddress'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'type': JsonConverters.toJson(type,'FileTypes',context!),
'accountId': accountId,
'accountName': accountName,
'customerId': customerId,
'customerName': customerName,
'customerBreadcrumb': JsonConverters.toJson(customerBreadcrumb,'List<CustomerBreadcrumb>',context!),
'userId': userId,
'userName': userName,
'fileName': fileName,
'uri': uri,
'contentType': contentType,
'contentLength': contentLength,
'recordingSid': recordingSid,
'recordingDuration': recordingDuration,
'recordingFrom': recordingFrom,
'transcription': transcription,
'fromAddress': fromAddress,
'toAddress': toAddress
});
getTypeName() => "FileInfo";
TypeContext? context = _ctx;
}
class NotificationInfo extends EntityInfo implements IConvertible
{
/**
* The account ID this endpoint is associated with
*/
// @ApiMember(Description="The account ID this endpoint is associated with")
String? accountId;
/**
* The name of the account this endpoint is associated with
*/
// @ApiMember(Description="The name of the account this endpoint is associated with")
String? accountName;
/**
* The ID of the customer this endpoint is associated with
*/
// @ApiMember(Description="The ID of the customer this endpoint is associated with")
String? customerId;
/**
* The name of the customer this endpoint is associated with
*/
// @ApiMember(Description="The name of the customer this endpoint is associated with")
String? customerName;
/**
* The breadcrumb to the customer for this endpoint
*/
// @ApiMember(Description="The breadcrumb to the customer for this endpoint")
List<CustomerBreadcrumb>? customerBreadcrumb;
/**
* The type of notification
*/
// @ApiMember(Description="The type of notification")
NotificationTypes? type;
/**
* The subject of the notification
*/
// @ApiMember(Description="The subject of the notification")
String? subject;
/**
* The body of the notification
*/
// @ApiMember(Description="The body of the notification")
String? body;
/**
* The recipients of this notification
*/
// @ApiMember(Description="The recipients of this notification")
List<NotificationRecipientInfo>? recipients;
/**
* The list of attachments
*/
// @ApiMember(Description="The list of attachments")
List<FileInfo>? attachments;
/**
* The original from for the session
*/
// @ApiMember(Description="The original from for the session")
String? from;
/**
* The original To for the session
*/
// @ApiMember(Description="The original To for the session")
String? to;
/**
* Was there an error?
*/
// @ApiMember(Description="Was there an error?")
bool? error;
/**
* The error message
*/
// @ApiMember(Description="The error message")
String? errorMessage;
NotificationInfo({this.accountId,this.accountName,this.customerId,this.customerName,this.customerBreadcrumb,this.type,this.subject,this.body,this.recipients,this.attachments,this.from,this.to,this.error,this.errorMessage});
NotificationInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
accountId = json['accountId'];
accountName = json['accountName'];
customerId = json['customerId'];
customerName = json['customerName'];
customerBreadcrumb = JsonConverters.fromJson(json['customerBreadcrumb'],'List<CustomerBreadcrumb>',context!);
type = JsonConverters.fromJson(json['type'],'NotificationTypes',context!);
subject = json['subject'];
body = json['body'];
recipients = JsonConverters.fromJson(json['recipients'],'List<NotificationRecipientInfo>',context!);
attachments = JsonConverters.fromJson(json['attachments'],'List<FileInfo>',context!);
from = json['from'];
to = json['to'];
error = json['error'];
errorMessage = json['errorMessage'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'accountId': accountId,
'accountName': accountName,
'customerId': customerId,
'customerName': customerName,
'customerBreadcrumb': JsonConverters.toJson(customerBreadcrumb,'List<CustomerBreadcrumb>',context!),
'type': JsonConverters.toJson(type,'NotificationTypes',context!),
'subject': subject,
'body': body,
'recipients': JsonConverters.toJson(recipients,'List<NotificationRecipientInfo>',context!),
'attachments': JsonConverters.toJson(attachments,'List<FileInfo>',context!),
'from': from,
'to': to,
'error': error,
'errorMessage': errorMessage
});
getTypeName() => "NotificationInfo";
TypeContext? context = _ctx;
}
class ResendNotification implements IConvertible
{
/**
* The ID of the notification to resend
*/
// @ApiMember(Description="The ID of the notification to resend")
String? notificationId;
ResendNotification({this.notificationId});
ResendNotification.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
notificationId = json['notificationId'];
return this;
}
Map<String, dynamic> toJson() => {
'notificationId': notificationId
};
getTypeName() => "ResendNotification";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
'EntityInfo': TypeInfo(TypeOf.AbstractClass),
'CustomerBreadcrumb': TypeInfo(TypeOf.Class, create:() => CustomerBreadcrumb()),
'NotificationTypes': TypeInfo(TypeOf.Enum, enumValues:NotificationTypes.values),
'NotificationRecipientInfo': TypeInfo(TypeOf.Class, create:() => NotificationRecipientInfo()),
'FileTypes': TypeInfo(TypeOf.Enum, enumValues:FileTypes.values),
'FileInfo': TypeInfo(TypeOf.Class, create:() => FileInfo()),
'List<CustomerBreadcrumb>': TypeInfo(TypeOf.Class, create:() => <CustomerBreadcrumb>[]),
'NotificationInfo': TypeInfo(TypeOf.Class, create:() => NotificationInfo()),
'List<NotificationRecipientInfo>': TypeInfo(TypeOf.Class, create:() => <NotificationRecipientInfo>[]),
'List<FileInfo>': TypeInfo(TypeOf.Class, create:() => <FileInfo>[]),
'ResendNotification': TypeInfo(TypeOf.Class, create:() => ResendNotification()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /notifications/{notificationId}/resend HTTP/1.1
Host: evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"notificationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"type":"Email","subject":"String","body":"String","recipients":[{"address":"String","extra":"String","name":"String"}],"attachments":[{"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"from":"String","to":"String","error":false,"errorMessage":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}