Subversion Repositories SmartDukaan

Rev

Rev 4020 | Rev 4267 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3026 mandeep.dh 1 
namespace java in.shop2020.crm
2 
namespace py shop2020.thriftpy.crm
3 
 
3374 rajveer 4 
include "GenericService.thrift"
5 
 
3026 mandeep.dh 6 
enum TicketPriority {
7 
    LOW = 0,
8 
    HIGH = 1,
9 
    MEDIUM = 2
10 
}
11 
 
12 
enum TicketStatus {
13 
    OPEN = 0,
14 
    CLOSED = 1,
15 
    REOPEN = 2
16 
}
17 
 
18 
enum TicketCategory {
19 
    RETURN_FORM = 1,
20 
    ORDER_CANCELLATION = 2,
21 
    DELIVERY_PROBLEM = 3,
22 
    PAYMENT_STATUS = 4,
23 
    ORDER_STATUS = 5,
24 
    PRODUCT_REQUEST = 6,
25 
    PRODUCT_QUESTION = 7,
3499 mandeep.dh 26 
    OTHER = 8,
3578 mandeep.dh 27 
    COD_VERIFICATION = 9,
4008 mandeep.dh 28 
    FAILED_PAYMENTS = 10,
29 
    DELAYED_DELIVERY = 11
3026 mandeep.dh 30 
}
31 
 
3106 mandeep.dh 32 
enum ActivityType {
3269 mandeep.dh 33 
    SEND_EMAIL_TO_CUSTOMER = 1,
3271 mandeep.dh 34 
    RECEIVED_EMAIL_FROM_CUSTOMER = 2,
3269 mandeep.dh 35 
    CALLED_CUSTOMER = 3,
3271 mandeep.dh 36 
    RECEIVED_CALL_FROM_CUSTOMER = 4,
4020 mandeep.dh 37 
    OTHER = 5,
38 
    ESCALATE_TICKET = 6
3106 mandeep.dh 39 
}
40 
 
3390 mandeep.dh 41 
struct Agent {
42 
    1:i64 id,
43 
    2:string name,
44 
    3:string emailId,
45 
    4:optional i64 managerId,
46 
    5:string password
47 
}
48 
 
3026 mandeep.dh 49 
struct Ticket {
50 
    1:i64 id,
3390 mandeep.dh 51 
    2:optional i64 customerId,
52 
    3:i64 openDate,
53 
    4:optional i64 closeDate,
54 
    5:optional string description,
55 
    6:TicketPriority priority,
56 
    7:TicketCategory category,
57 
    8:TicketStatus status,
58 
    9:optional i64 assigneeId,
59 
   10:i64 creatorId,
60 
   11:optional i64 orderId,
61 
   12:optional string airwayBillNo,
62 
   13:optional string productName,
63 
 
64 
   // used for un-registered users
65 
   14:optional string customerMobileNumber,
66 
   15:optional string customerEmailId,
3546 mandeep.dh 67 
   16:optional string customerName
3026 mandeep.dh 68 
}
69 
 
70 
struct Activity {
71 
    1:i64 id,
3168 mandeep.dh 72 
    2:optional string description,
3106 mandeep.dh 73 
    3:i64 creationTimestamp, // represents time at which this activity occurred
74 
    4:ActivityType type,
3269 mandeep.dh 75 
    5:optional i64 customerId, // used for registered users
3390 mandeep.dh 76 
    6:i64 creatorId,
3026 mandeep.dh 77 
 
3269 mandeep.dh 78 
    // represents the numeric identifier for the emails sent to customers
79 
    // These are archived in helper..useremailarchive or helper..useremail
3390 mandeep.dh 80 
    7:optional i64 userEmailId,
3269 mandeep.dh 81 
 
3106 mandeep.dh 82 
    // ticket related fields to track changes on ticket fields
3390 mandeep.dh 83 
    8:optional i64 ticketId,
84 
    9:optional TicketPriority ticketPriority,
85 
   10:optional i64 ticketAssigneeId,
86 
   11:optional TicketStatus ticketStatus,
87 
   12:optional TicketCategory ticketCategory,
88 
   13:optional string ticketDescription,
89 
 
90 
   // Activities created as part of mails received from customers
91 
   // have to be explicitly marked as read by agents in CRM.
92 
   // This flag is set over such activities when any agent marks it as read!
3546 mandeep.dh 93 
   14:optional bool isRead,
3390 mandeep.dh 94 
 
95 
   // used for un-registered users
96 
   15:optional string customerMobileNumber,
97 
   16:optional string customerEmailId,
98 
   17:optional string customerName,
4241 anupam.sin 99 
 
100 
   // used for attachments name separated by semicolon
101 
   18:optional string attachments
3026 mandeep.dh 102 
}
103 
 
3390 mandeep.dh 104 
struct SearchFilter {
105 
    1:optional i64 ticketId,
106 
    2:optional i64 activityId,
107 
    3:optional list<i64> ticketAssigneeIds,
108 
    4:optional list<i64> activityCreatorIds,
109 
    5:optional i64 agentId,
110 
    6:optional i64 customerId,
111 
    7:optional i64 startTimestamp,
112 
    8:optional i64 endTimestamp,
113 
    9:optional bool isActivityRead,
114 
   10:optional string agentEmailId,
115 
   11:optional string customerEmailId,
3499 mandeep.dh 116 
   12:optional string customerMobileNumber,
3546 mandeep.dh 117 
   13:optional list<TicketStatus> ticketStatuses,
3499 mandeep.dh 118 
   14:optional TicketCategory ticketCategory,
3546 mandeep.dh 119 
   15:optional TicketPriority ticketPriority,
120 
   16:optional ActivityType activityType
3026 mandeep.dh 121 
}
122 
 
3374 rajveer 123 
service CRMService extends GenericService.GenericService{
3026 mandeep.dh 124 
    // Methods to read/write tickets from/in database
3390 mandeep.dh 125 
    list<Ticket> getTickets(1:SearchFilter searchFilter);
3137 mandeep.dh 126 
    list<Ticket> getUnassignedTickets();
3206 mandeep.dh 127 
    void updateTicket(1:Ticket ticket, 2:Activity activity);
128 
    i64 insertTicket(1:Ticket ticket, 2:Activity activity);
3026 mandeep.dh 129 
 
130 
    // Methods to read/write activities from/in database
3390 mandeep.dh 131 
    list<Activity> getActivities(1:SearchFilter searchFilter);
3405 mandeep.dh 132 
    i64 insertActivity(1:Activity activity);
3390 mandeep.dh 133 
    void markAsRead(1:i64 activityId, 2:i64 agentId);
3026 mandeep.dh 134 
 
135 
    // Methods to read agent information
3390 mandeep.dh 136 
    list<Agent> getAgents(1:SearchFilter searchFilter);
3087 mandeep.dh 137 
    void updatePasswordForAgent(1:string agentEmailId, 2:string password);
138 
 
139 
    // Methods to read roles and permissions information
140 
    list<string> getRoleNamesForAgent(1:string agentEmailId);
3106 mandeep.dh 141 
    list<string> getPermissionsForRoleName(1:string roleName);
3339 mandeep.dh 142 
 
143 
    // Misc methods
144 
    i64 getLastEmailProcessedTimestamp();
145 
    void updateLastEmailProcessedTimestamp(1:i64 timestamp);
3026 mandeep.dh 146 
}