| POST | /thunderbolt/submit |
|---|
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 ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
# @ApiMember(DataType="double", Description="Latitude of the user making this request")
latitude: float = 0.0
"""
Latitude of the user making this request
"""
# @ApiMember(DataType="double", Description="Longitude of the user making this request")
longitude: float = 0.0
"""
Longitude of the user making this request
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EnumOption:
value: int = 0
label: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThunderBoltActionData:
id: int = 0
action_name: Optional[str] = None
color: Optional[str] = None
daily_action_count: int = 0
show_number_input: bool = False
show_email_input: bool = False
show_platform_input: bool = False
show_date_time_input: bool = False
contact_interaction_platforms: Optional[List[EnumOption]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ThunderBoltActionEventData:
id: int = 0
created_date: Optional[str] = None
action_id: int = 0
action_name: Optional[str] = None
color: Optional[str] = None
notes: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactData:
contact_id: int = 0
contact_name: Optional[str] = None
email: Optional[str] = None
phone_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetThunderBoltActionsResponse(ApiServiceResponse):
daily_actions_number: int = 0
supporting_document_probability: int = 0
thunder_bolt_actions: Optional[List[ThunderBoltActionData]] = None
thunder_bolt_action_events: Optional[List[ThunderBoltActionEventData]] = None
contacts: Optional[List[ContactData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubmitThunderBoltActionResponse(GetThunderBoltActionsResponse):
thunderbolt_action_event_id: int = 0
class ContactInteractionPlatform(IntEnum):
NONE = 0
WHATSAPP = 1
LINKUS = 2
MOBILE = 3
OUTLOOK = 4
LINKED_IN = 5
TELEGRAM = 6
SIGNAL = 7
SMS = 8
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubmitThunderBoltAction(ApiServiceRequest):
action_id: int = 0
platform: Optional[ContactInteractionPlatform] = None
number: Optional[str] = None
email: Optional[str] = None
notes: Optional[str] = None
date_time: datetime.datetime = datetime.datetime(1, 1, 1)
contact_id: int = 0
Python SubmitThunderBoltAction 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.
POST /thunderbolt/submit HTTP/1.1
Host: cochraneplus-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
actionId: 0,
platform: 0,
number: String,
email: String,
notes: String,
dateTime: 0001-01-01,
contactId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
thunderboltActionEventId: 0,
dailyActionsNumber: 0,
supportingDocumentProbability: 0,
thunderBoltActions:
[
{
id: 0,
actionName: String,
color: String,
dailyActionCount: 0,
showNumberInput: False,
showEmailInput: False,
showPlatformInput: False,
showDateTimeInput: False,
contactInteractionPlatforms:
[
{
value: 0,
label: String
}
]
}
],
thunderBoltActionEvents:
[
{
id: 0,
createdDate: String,
actionId: 0,
actionName: String,
color: String,
notes: String
}
],
contacts:
[
{
}
],
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}