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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RuleValidationResult:
rule_code: Optional[str] = None
message: Optional[str] = None
key: Optional[str] = None
tag: Optional[str] = None
error_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationErrorList:
validation_errors: Optional[List[RuleValidationResult]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionLinkContact:
# @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
contact_id: Optional[str] = None
"""
Guid of the contact object within Eros.
"""
# @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
contact_alternate_key: Optional[str] = None
"""
The unique key that represents the contact on the external system.
"""
# @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
role_id: Optional[str] = None
"""
Guid of the Role List Item object within Eros.
"""
# @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
role_alternate_key: Optional[str] = None
"""
The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactGroupConnectionModel(SubscriptionLinkContact):
# @ApiMember(DataType="int", Description="The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth.", Name="Index", ParameterType="query")
index: int = 0
"""
The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth.
"""
# @ApiMember(DataType="bool", Description="Set this to be true if the contact connection to the group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
mark_as_deleted: bool = False
"""
Set this to be true if the contact connection to the group is to be deleted
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactGroupModel:
# @ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
contact_group_name: Optional[str] = None
"""
A name for the contact group.
"""
# @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros that defines the role of the group.", IsRequired=true, Name="GroupRoleId", ParameterType="query")
group_role_id: Optional[str] = None
"""
Guid of the Role List Item object within Eros that defines the role of the group.
"""
# @ApiMember(DataType="string", Description="The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
role_alternate_key: Optional[str] = None
"""
The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
"""
# @ApiMember(DataType="List<SubscriptionContactGroupConnectionModel>", Description="A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.", Name="ContactConnections", ParameterType="query")
contact_connections: Optional[List[SubscriptionContactGroupConnectionModel]] = None
"""
A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
"""
# @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
mark_as_deleted: bool = False
"""
Set this to be true if the contact group is to be deleted
"""
# @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be archived", Name="MarkAsArchived", ParameterType="query")
mark_as_archived: bool = False
"""
Set this to be true if the contact group is to be archived
"""
# @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be restored", Name="MarkAsRestored", ParameterType="query")
mark_as_restored: bool = False
"""
Set this to be true if the contact group is to be restored
"""
# @Api(Description="Inserts or Updates a contact group and its contact connections.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveContactGroup(ValidationErrorList, ISubscription):
"""
Inserts or Updates a contact group and its contact connections.
"""
# @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
suite_data_source_instance_id: Optional[str] = None
"""
Guid representing the external systems datasource information.
"""
# @ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
alternate_key: Optional[str] = None
"""
The unique key that represents the contact group on the external system.
"""
# @ApiMember(DataType="Guid", Description="Guid of the contact group object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key.", Name="ObjectId", ParameterType="query")
object_id: Optional[str] = None
"""
Guid of the contact group object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key.
"""
# @ApiMember(DataType="bool", Description="If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.", Name="IgnoreHash")
ignore_hash: bool = False
"""
If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save.
"""
# @ApiMember(DataType="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")
contact_group: Optional[SubscriptionContactGroupModel] = None
"""
Object containing all details of the contact group to be inserted or updated.
"""
ignore_validation: bool = False
licensee_id: Optional[str] = None
session_id: Optional[str] = None
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.
POST /jsv/reply/SaveContactGroup HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
IgnoreHash: False,
ContactGroup:
{
ContactGroupName: String,
RoleAlternateKey: String,
ContactConnections:
[
{
Index: 0,
MarkAsDeleted: False,
ContactAlternateKey: String,
RoleAlternateKey: String
}
],
MarkAsDeleted: False,
MarkAsArchived: False,
MarkAsRestored: False
},
IgnoreValidation: False,
ValidationErrors:
[
{
RuleCode: String,
Message: String,
Key: String,
Tag: String,
ErrorCode: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}