ClubManager.Api

<back to all web services

FindMessage

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageTemplateInstance:
    message_template_id: Optional[int] = None
    name: Optional[str] = None
    subject: Optional[str] = None
    body: Optional[str] = None
    report_id: Optional[int] = None
    template_type: Optional[int] = None
    created: Optional[datetime.datetime] = None
    created_by: Optional[int] = None
    modified: Optional[datetime.datetime] = None
    modified_by: Optional[int] = None
    deleted: Optional[datetime.datetime] = None
    deleted_by: Optional[int] = None
    event_type: Optional[int] = None
    content_type: Optional[int] = None
    hidden: Optional[bool] = None
    parent_message_template_id: Optional[int] = None
    inclusion_tags: Optional[str] = None
    exclusion_tags: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInstance:
    user_id: Optional[int] = None
    user_name: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    mobile_phone: Optional[str] = None
    enabled: Optional[bool] = None
    last_login: Optional[datetime.datetime] = None
    created: Optional[datetime.datetime] = None
    training: Optional[bool] = None
    deleted: Optional[bool] = None
    courses_completed: Optional[int] = None
    display_home_notification: Optional[bool] = None
    two_factor_enabled: Optional[bool] = None
    email_confirmed: Optional[bool] = None
    mobile_phone_confirmed: Optional[bool] = None
    notifications: Optional[bool] = None
    change_password: Optional[datetime.datetime] = None
    activated: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageInstance:
    message_id: Optional[int] = None
    due_date: Optional[datetime.datetime] = None
    sent_date: Optional[datetime.datetime] = None
    processed: Optional[bool] = None
    failures: Optional[int] = None
    instance_id: Optional[int] = None
    message_sid: Optional[str] = None
    message_template: Optional[MessageTemplateInstance] = None
    # @References(typeof(MessageTemplateInstance))
    message_template_id: Optional[int] = None

    opened_date: Optional[datetime.datetime] = None
    bounced_date: Optional[datetime.datetime] = None
    delivered_date: Optional[datetime.datetime] = None
    unsubscribed_date: Optional[datetime.datetime] = None
    spam_report_date: Optional[datetime.datetime] = None
    user: Optional[UserInstance] = None
    # @References(typeof(UserInstance))
    user_id: Optional[int] = None

    instance_type: Optional[int] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Message")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindMessage(QueryDb[MessageInstance]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: Optional[int] = None
    total: Optional[int] = None
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python FindMessage DTOs

POST /api/Query/Message HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			MessageId: 0,
			DueDate: 0001-01-01,
			SentDate: 0001-01-01,
			Processed: False,
			Failures: 0,
			InstanceId: 0,
			MessageSid: String,
			MessageTemplate: 
			{
				MessageTemplateId: 0,
				Name: String,
				Subject: String,
				Body: String,
				ReportId: 0,
				TemplateType: 0,
				Created: 0001-01-01,
				CreatedBy: 0,
				Modified: 0001-01-01,
				ModifiedBy: 0,
				Deleted: 0001-01-01,
				DeletedBy: 0,
				EventType: 0,
				ContentType: 0,
				Hidden: False,
				ParentMessageTemplateId: 0,
				InclusionTags: String,
				ExclusionTags: String
			},
			MessageTemplateId: 0,
			OpenedDate: 0001-01-01,
			BouncedDate: 0001-01-01,
			DeliveredDate: 0001-01-01,
			UnsubscribedDate: 0001-01-01,
			SpamReportDate: 0001-01-01,
			User: 
			{
				UserId: 0,
				UserName: String,
				Name: String,
				Email: String,
				MobilePhone: String,
				Enabled: False,
				LastLogin: 0001-01-01,
				Created: 0001-01-01,
				Training: False,
				Deleted: False,
				CoursesCompleted: 0,
				DisplayHomeNotification: False,
				TwoFactorEnabled: False,
				EmailConfirmed: False,
				MobilePhoneConfirmed: False,
				Notifications: False,
				ChangePassword: 0001-01-01,
				Activated: 0001-01-01
			},
			UserId: 0,
			InstanceType: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}