Evo Voice

<back to all web services

ListSettingsObjects

Get all configurable settings objects for the authenticated user

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class SettingsObjectTypes(str, Enum):
    ENDPOINT = 'Endpoint'
    CUSTOMER = 'Customer'


class EndpointTypes(str, Enum):
    PHONE_NUMBER = 'PhoneNumber'
    USER = 'User'
    FAX_NUMBER = 'FaxNumber'
    EMAIL_ADDRESS = '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'


class ValueTypes(str, Enum):
    NOT_SPECIFIED = 'NotSpecified'
    STRING = 'String'
    BOOLEAN = 'Boolean'
    NUMBER = 'Number'
    LIST = 'List'
    STRUCT = 'Struct'
    TRANSITION = 'Transition'
    CUSTOM = 'Custom'
    DATE = 'Date'
    AUDIO_FILE = 'AudioFile'
    TIME_ZONE_ID = 'TimeZoneId'
    PHONE_NUMBER = 'PhoneNumber'
    USER = 'User'
    ENDPOINT = 'Endpoint'
    TIME = 'Time'
    FILE = 'File'
    FAX_NUMBER = 'FaxNumber'
    EMAIL_ACCOUNT = 'EmailAccount'
    CUSTOMER = 'Customer'
    FLOW = 'Flow'
    TEAM = 'Team'
    FLOW_REFERENCE = 'FlowReference'
    INTEGRATION = 'Integration'
    ASSISTANT = 'Assistant'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Struct(Dict[str,Value]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Value:
    bool_value: Optional[bool] = None
    string_value: Optional[str] = None
    number_value: Optional[float] = None
    list_value: Optional[List[Struct]] = None
    struct_value: Optional[Struct] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettingsPossibleValue:
    display_name: Optional[str] = None
    value: Optional[Value] = None


class UIHints(str, Enum):
    NONE = 'None'
    LARGE_TEXT = 'LargeText'
    INLINE_FORM = 'InlineForm'
    PASSWORD = 'Password'
    INLINE_STRUCT = 'InlineStruct'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataType:
    type_name: Optional[str] = None
    fields: Optional[List[DataField]] = None


class DataFieldUniqueness(str, Enum):
    NOT_UNIQUE = 'NotUnique'
    UNIQUE = 'Unique'
    UNIQUE_TO_CUSTOMER = 'UniqueToCustomer'


class UserDataFieldModes(str, Enum):
    HIDDEN = 'Hidden'
    READ_ONLY = 'ReadOnly'
    READ_WRITE = 'ReadWrite'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataField:
    id: Optional[str] = None
    name: Optional[str] = None
    type: Optional[ValueTypes] = None
    ui_hint: Optional[UIHints] = None
    ui_tab: Optional[str] = None
    is_async: bool = False
    disable_binding: bool = False
    struct_type: Optional[DataType] = None
    list_type: Optional[DataType] = None
    description: Optional[str] = None
    possible_values: Optional[List[str]] = None
    is_output: bool = False
    custom_field_values_url: Optional[str] = None
    default_value: Optional[Value] = None
    transition_name_format: Optional[str] = None
    uniqueness: Optional[DataFieldUniqueness] = None
    voice_only: bool = False
    conditional_visibility_field: Optional[str] = None
    conditional_visibility_value: Optional[str] = None
    no_eval_template: bool = False
    user_mode: Optional[UserDataFieldModes] = None
    any_value_type: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettingsField:
    name: Optional[str] = None
    display_name: Optional[str] = None
    type: Optional[ValueTypes] = None
    value: Optional[Value] = None
    read_only: bool = False
    possible_values: Optional[List[SettingsPossibleValue]] = None
    data_field: Optional[DataField] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettingsObject:
    id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    read_only: bool = False
    type: Optional[SettingsObjectTypes] = None
    endpoint_type: Optional[EndpointTypes] = None
    fields: Optional[List[SettingsField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListSettingsObjectsResponse:
    settings_objects: Optional[List[SettingsObject]] = None


# @Api(Description="Get all configurable settings objects for the authenticated user")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListSettingsObjects(IGet):
    """
    Get all configurable settings objects for the authenticated user
    """

    pass

Python ListSettingsObjects DTOs

GET /app/settings-objects HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	settingsObjects: 
	[
		{
			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: 
						[
							null
						]
					},
					readOnly: False,
					possibleValues: 
					[
						{
							displayName: String,
							value: 
							{
								boolValue: False,
								stringValue: String,
								numberValue: 0,
								listValue: 
								[
									null
								]
							}
						}
					]
				}
			]
		}
	]
}