| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| PATCH | /files/{fileId} |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Updates metadata for the specific file
*/
@Api(Description="Updates metadata for the specific file")
open class PatchFile : IPatch
{
/**
* The ID of the file
*/
@ApiMember(Description="The ID of the file")
var fileId:String? = null
/**
* The new file name for the file
*/
@ApiMember(Description="The new file name for the file")
var fileName:String? = null
/**
* The customer ID to associate with this file
*/
@ApiMember(Description="The customer ID to associate with this file")
var customerId:String? = null
/**
* The ID of the user to associate with this file
*/
@ApiMember(Description="The ID of the user to associate with this file")
var userId:String? = null
}
open class FileInfo : EntityInfo()
{
/**
* The type of file this is
*/
@ApiMember(Description="The type of file this is")
@SerializedName("type") var Type:FileTypes? = null
/**
* The account ID this file is associated with
*/
@ApiMember(Description="The account ID this file is associated with")
var accountId:String? = null
/**
* The name of the account this file is associated with
*/
@ApiMember(Description="The name of the account this file is associated with")
var accountName:String? = null
/**
* The ID of the customer this file is associated with
*/
@ApiMember(Description="The ID of the customer this file is associated with")
var customerId:String? = null
/**
* The name of the customer this file is associated with
*/
@ApiMember(Description="The name of the customer this file is associated with")
var customerName:String? = null
/**
* The breadcrumb to the customer for this file
*/
@ApiMember(Description="The breadcrumb to the customer for this file")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The ID of the user this file is assocaited with
*/
@ApiMember(Description="The ID of the user this file is assocaited with")
var userId:String? = null
/**
* The name of the user this file is associated with
*/
@ApiMember(Description="The name of the user this file is associated with")
var userName:String? = null
/**
* The original file name for the file
*/
@ApiMember(Description="The original file name for the file")
var fileName:String? = null
/**
* The URI of the file
*/
@ApiMember(Description="The URI of the file")
var uri:String? = null
/**
* The Content type of the file
*/
@ApiMember(Description="The Content type of the file")
var contentType:String? = null
/**
* The size of the file
*/
@ApiMember(Description="The size of the file")
var contentLength:Long? = null
/**
* The Twilio ID of the recording
*/
@ApiMember(Description="The Twilio ID of the recording")
var recordingSid:String? = null
/**
* The duration of the recording in seconds
*/
@ApiMember(Description="The duration of the recording in seconds")
var recordingDuration:Int? = null
/**
* Who is the recording from?
*/
@ApiMember(Description="Who is the recording from?")
var recordingFrom:String? = null
/**
* Transcription (if available)
*/
@ApiMember(Description="Transcription (if available)")
var transcription:String? = null
/**
* From Address (e.g. caller ID) for incoming calls
*/
@ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
var fromAddress:String? = null
/**
* To Address (e.g. dialed number) for outgoing calls
*/
@ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
var toAddress:String? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
enum class FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
open class CustomerBreadcrumb
{
var id:String? = null
var name:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /files/{fileId} HTTP/1.1
Host: evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
fileId: String,
fileName: String,
customerId: String,
userId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}