| Required role: | User |
| PATCH | /app/settings-objects/{id} |
|---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum SettingsObjectTypes
{
Endpoint = 'Endpoint',
Customer = 'Customer',
}
export enum EndpointTypes
{
PhoneNumber = 'PhoneNumber',
User = 'User',
FaxNumber = 'FaxNumber',
EmailAddress = 'EmailAddress',
Unused_1 = 'Unused_1',
Unused_2 = 'Unused_2',
Unused_3 = 'Unused_3',
Unused_4 = 'Unused_4',
Unused_5 = 'Unused_5',
Team = 'Team',
}
export enum ValueTypes
{
NotSpecified = 'NotSpecified',
String = 'String',
Boolean = 'Boolean',
Number = 'Number',
List = 'List',
Struct = 'Struct',
Transition = 'Transition',
Custom = 'Custom',
Date = 'Date',
AudioFile = 'AudioFile',
TimeZoneId = 'TimeZoneId',
PhoneNumber = 'PhoneNumber',
User = 'User',
Endpoint = 'Endpoint',
Time = 'Time',
File = 'File',
FaxNumber = 'FaxNumber',
EmailAccount = 'EmailAccount',
Customer = 'Customer',
Flow = 'Flow',
Team = 'Team',
FlowReference = 'FlowReference',
Integration = 'Integration',
}
export class Struct
{
public constructor(init?: Partial<Struct>) { (Object as any).assign(this, init); }
}
export class Value
{
public boolValue?: boolean;
public stringValue?: string;
public numberValue?: number;
public listValue?: Struct[];
public structValue?: Struct;
public constructor(init?: Partial<Value>) { (Object as any).assign(this, init); }
}
export class SettingsPossibleValue
{
public displayName?: string;
public value?: Value;
public constructor(init?: Partial<SettingsPossibleValue>) { (Object as any).assign(this, init); }
}
export enum UIHints
{
None = 'None',
LargeText = 'LargeText',
InlineForm = 'InlineForm',
Password = 'Password',
InlineStruct = 'InlineStruct',
}
export class DataType
{
public typeName?: string;
public fields?: DataField[];
public constructor(init?: Partial<DataType>) { (Object as any).assign(this, init); }
}
export enum DataFieldUniqueness
{
NotUnique = 'NotUnique',
Unique = 'Unique',
UniqueToCustomer = 'UniqueToCustomer',
}
export enum UserDataFieldModes
{
Hidden = 'Hidden',
ReadOnly = 'ReadOnly',
ReadWrite = 'ReadWrite',
}
export class DataField
{
public id?: string;
public name?: string;
public type?: ValueTypes;
public uiHint?: UIHints;
public uiTab?: string;
public isAsync?: boolean;
public disableBinding?: boolean;
public structType?: DataType;
public listType?: DataType;
public description?: string;
public possibleValues?: string[];
public isOutput?: boolean;
public customFieldValuesUrl?: string;
public defaultValue?: Value;
public transitionNameFormat?: string;
public uniqueness?: DataFieldUniqueness;
public voiceOnly?: boolean;
public conditionalVisibilityField?: string;
public conditionalVisibilityValue?: string;
public noEvalTemplate?: boolean;
public userMode?: UserDataFieldModes;
public anyValueType?: boolean;
public constructor(init?: Partial<DataField>) { (Object as any).assign(this, init); }
}
export class SettingsField
{
public name?: string;
public displayName?: string;
public type?: ValueTypes;
public value?: Value;
public readOnly?: boolean;
public possibleValues?: SettingsPossibleValue[];
public dataField?: DataField;
public constructor(init?: Partial<SettingsField>) { (Object as any).assign(this, init); }
}
export class SettingsObject
{
public id?: string;
public name?: string;
public description?: string;
public readOnly?: boolean;
public type?: SettingsObjectTypes;
public endpointType?: EndpointTypes;
public fields?: SettingsField[];
public constructor(init?: Partial<SettingsObject>) { (Object as any).assign(this, init); }
}
/**
* Update the specified settings object
*/
// @Api(Description="Update the specified settings object")
export class PatchSettingsObject implements IPatch
{
/**
* The ID of the settings object
*/
// @ApiMember(Description="The ID of the settings object")
public id?: string;
/**
* The data values to set
*/
// @ApiMember(Description="The data values to set")
public data?: Struct;
public constructor(init?: Partial<PatchSettingsObject>) { (Object as any).assign(this, init); }
}
TypeScript PatchSettingsObject DTOs
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 /app/settings-objects/{id} HTTP/1.1
Host: evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
data:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
}
}
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: String,
name: String,
description: String,
readOnly: False,
type: Endpoint,
endpointType: PhoneNumber,
fields:
[
{
name: String,
displayName: String,
type: NotSpecified,
value:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
readOnly: False,
possibleValues:
[
{
displayName: String,
value:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
}
}
],
dataField:
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
}
]
},
listType:
{
typeName: String,
fields:
[
{
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
}
]
},
listType:
{
typeName: String,
fields:
[
{
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
}
]
},
listType:
{
typeName: String,
fields:
[
{
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
}
]
},
listType:
{
typeName: String,
fields:
[
{
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
}
]
}