PATCH | /portal/system-settings |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
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',
Assistant = 'Assistant',
}
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 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 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 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',
Assistant = 'Assistant',
}
export class EndpointDataField extends DataField
{
public showInSearch: boolean;
public showInLists: boolean;
public endpointType?: EndpointTypes;
public isCallerId: boolean;
public isKnob: boolean;
public constructor(init?: Partial<EndpointDataField>) { super(init); (Object as any).assign(this, init); }
}
export class AppSystemSettingsInfo
{
public endpointFields: EndpointDataField[];
/** @description Is this customer a HostedSuite customer? */
// @ApiMember(Description="Is this customer a HostedSuite customer?")
public isHostedSuiteCustomer: boolean;
/** @description The customer's time zone */
// @ApiMember(Description="The customer's time zone")
public customerTimeZoneId: string;
public constructor(init?: Partial<AppSystemSettingsInfo>) { (Object as any).assign(this, init); }
}
export class AppUpdateSystemSettings
{
public accountId: string;
public customerId: string;
public customerTimeZoneId: string;
public constructor(init?: Partial<AppUpdateSystemSettings>) { (Object as any).assign(this, init); }
}
TypeScript AppUpdateSystemSettings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /portal/system-settings HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AppUpdateSystemSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal">
<AccountId>String</AccountId>
<CustomerId>String</CustomerId>
<CustomerTimeZoneId>String</CustomerTimeZoneId>
</AppUpdateSystemSettings>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AppSystemSettingsInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal"> <CustomerTimeZoneId>String</CustomerTimeZoneId> <EndpointFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings"> <d2p1:EndpointDataField> <AnyValueType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</AnyValueType> <ConditionalVisibilityField xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityField> <ConditionalVisibilityValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityValue> <CustomFieldValuesUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</CustomFieldValuesUrl> <DefaultValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data"> <BoolValue>false</BoolValue> <ListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" /> </ListValue> <NumberValue>0</NumberValue> <StringValue>String</StringValue> <StructValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> </DefaultValue> <Description xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Description> <DisableBinding xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</DisableBinding> <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Id> <IsAsync xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsAsync> <IsOutput xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsOutput> <ListType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" /> <Name xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Name> <NoEvalTemplate xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</NoEvalTemplate> <PossibleValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data"> <d4p1:string>String</d4p1:string> </PossibleValues> <StructType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" /> <TransitionNameFormat xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</TransitionNameFormat> <Type xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotSpecified</Type> <UIHint xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">None</UIHint> <UITab xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</UITab> <Uniqueness xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotUnique</Uniqueness> <UserMode xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">Hidden</UserMode> <VoiceOnly xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</VoiceOnly> <d2p1:EndpointType>PhoneNumber</d2p1:EndpointType> <d2p1:IsCallerId>false</d2p1:IsCallerId> <d2p1:IsKnob>false</d2p1:IsKnob> <d2p1:ShowInLists>false</d2p1:ShowInLists> <d2p1:ShowInSearch>false</d2p1:ShowInSearch> </d2p1:EndpointDataField> </EndpointFields> <IsHostedSuiteCustomer>false</IsHostedSuiteCustomer> </AppSystemSettingsInfo>