Repository navigation
Expand file tree
/
Copy pathmodels.ts
More file actions
163 lines (160 loc) · 3.08 KB
/
Copy pathmodels.ts
File metadata and controls
163 lines (160 loc) · 3.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
export type MessageSendRequest = {
/**
@example "This is a sample text message"
*/
content: string;
/**
@example "+18005550199"
*/
from: string;
/**
@example "+18005550100"
*/
to: string;
/**
* The request_id field is an optional parameter used to track a request from the client's perspective
* @example "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
*/
request_id?: string;
/**
* The send_at field is an optional parameter used to schedule a message to be sent at a later time
* @example "2022-06-05T14:26:09.527976+03:00"
*/
send_at?: Date;
/**
* This encrypted field is an optional parameter which determines weather or not the message content is encrypted.
* Note that you have to also set the encryption key on the Android app for this feature to work properly.
* @example false
*/
encrypted?: boolean;
};
export type MessageResponse = {
data: Message;
/**
@example "message added to queue"
*/
message: string;
/**
@example "success"
*/
status: string;
};
export enum Sim {
SIM1 = 'SIM1',
SIM2 = 'SIM2',
}
export type Message = {
/**
@example false
*/
can_be_polled: boolean;
/**
@example "+18005550100"
*/
contact: string;
/**
@example "This is a sample text message"
*/
content: string;
/**
@example false
*/
encrypted: boolean;
/**
@example "2022-06-05T14:26:02.302718+03:00"
*/
created_at: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
delivered_at: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
expired_at: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
failed_at: string;
/**
@example "UNKNOWN"
*/
failure_reason: string;
/**
@example "32343a19-da5e-4b1b-a767-3298a73703cb"
*/
id: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
last_attempted_at: string;
/**
@example 1
*/
max_send_attempts: number;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
order_timestamp: string;
/**
@example "+18005550199"
*/
owner: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
received_at: string;
/**
@example "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
*/
request_id: string;
/**
@example "2022-06-05T14:26:01.520828+03:00"
*/
request_received_at: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
scheduled_at: string;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
scheduled_send_time: string;
/**
@example 0
*/
send_attempt_count: number;
/**
* SendDuration is the number of nanoseconds from when the request was received until when the mobile phone send the message
* @example 133414
*/
send_time: number;
/**
@example "2022-06-05T14:26:09.527976+03:00"
*/
sent_at: string;
/**
* SIM is the SIM card to use to send the message
* * SMS1: use the SIM card in slot 1
* * SMS2: use the SIM card in slot 2
* * DEFAULT: used the default communication SIM card
* @example "DEFAULT"
*/
sim: Sim;
/**
@example "pending"
*/
status: string;
/**
@example "mobile-terminated"
*/
type: string;
/**
@example "2022-06-05T14:26:10.303278+03:00"
*/
updated_at: string;
/**
@example "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
*/
user_id: string;
};