1 | // BEGIN Resources |
---|
2 | // |
---|
3 | // params = |
---|
4 | // 0 - Valores : text, passowrd |
---|
5 | // Descrição: Tipo do campo text ou password; |
---|
6 | // 1 - Valores : enabled, disabled |
---|
7 | // Descrição : Se a input está habilitada para inserir dados |
---|
8 | // 2 - Valores : string |
---|
9 | // Descrição : tipo do dado |
---|
10 | // 3 - Valores : true, false |
---|
11 | // Descrição : Se o campo é um valor obrigatório para as requisições |
---|
12 | // 4 - Valores : vazio ou qualquer outro valor que seja padrão |
---|
13 | // Descrição : Caso o campo necessite de um valor default |
---|
14 | // 5 - Valores : Campo aberto |
---|
15 | // Descrição : Utilizado para informar ao usuário qual o tipo da informação é necessária |
---|
16 | |
---|
17 | var resources_expresso = |
---|
18 | { |
---|
19 | login : |
---|
20 | { |
---|
21 | apps : [], |
---|
22 | id : "login", |
---|
23 | description : "Realiza a autenticação do usuário", |
---|
24 | method : ["POST"], |
---|
25 | rest : "Login", |
---|
26 | click : "execute.ajax('login')", |
---|
27 | params : |
---|
28 | { |
---|
29 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
30 | id :["text", "enabled", "string", false, "", "ID para o resource Login."], |
---|
31 | user :["text", "enabled", "string", true, "", "Login do Usuário"], |
---|
32 | password:["password", "enabled", "string", true, "", "Senha do Usuário"] |
---|
33 | } |
---|
34 | }, |
---|
35 | |
---|
36 | logout : |
---|
37 | { |
---|
38 | apps : [], |
---|
39 | id : "logout", |
---|
40 | description : "Desloga o usuário, invalidando a chave de autenticação", |
---|
41 | method : ["POST"], |
---|
42 | rest : "Logout", |
---|
43 | click : "execute.ajax('logout')", |
---|
44 | params : |
---|
45 | { |
---|
46 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"] |
---|
47 | } |
---|
48 | }, |
---|
49 | |
---|
50 | expresso_version : |
---|
51 | { |
---|
52 | apps : [], |
---|
53 | id : "expresso_version", |
---|
54 | description : "Retorna a versão do Expressos e a Versão da API instalada", |
---|
55 | method : ["POST","GET"], |
---|
56 | rest : "ExpressoVersion", |
---|
57 | click : "execute.ajax('expresso_version')" |
---|
58 | }, |
---|
59 | |
---|
60 | mail_folders : |
---|
61 | { |
---|
62 | apps : ["mail"], |
---|
63 | id : "mail_folders", |
---|
64 | description : "Lista as pastas do usuários", |
---|
65 | method : ["POST"], |
---|
66 | rest : "Mail/Folders", |
---|
67 | click : "execute.ajax('mail_folders')", |
---|
68 | params : |
---|
69 | { |
---|
70 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
71 | folderID :["text", "enabled", "string", false, "", "Pasta base para a busca"], |
---|
72 | search :["text", "enabled", "string", false, "", "Buscar pastas com o nome" ] |
---|
73 | } |
---|
74 | }, |
---|
75 | |
---|
76 | mail_add_folder : |
---|
77 | { |
---|
78 | apps : ["mail"], |
---|
79 | id : "mail_add_folder", |
---|
80 | description : "Adiciona uma nova pasta.", |
---|
81 | method : ["POST"], |
---|
82 | rest : "Mail/AddFolder", |
---|
83 | click : "execute.ajax('mail_add_folder')", |
---|
84 | params : |
---|
85 | { |
---|
86 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
87 | parentfolderID :["text", "enabled", "string", true, "INBOX", "Pasta base para adicionar a nova pasta."], |
---|
88 | folderName :["text", "enabled", "string", true, "", "Nome da nova Pasta."] |
---|
89 | } |
---|
90 | }, |
---|
91 | |
---|
92 | mail_messages : |
---|
93 | { |
---|
94 | apps : ["mail"], |
---|
95 | id : "mail_messages", |
---|
96 | description : "Retorna as mensagens do usuário", |
---|
97 | method : ["POST"], |
---|
98 | rest : "Mail/Messages", |
---|
99 | click : "execute.ajax('mail_messages')", |
---|
100 | params : |
---|
101 | { |
---|
102 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
103 | folderID :["text", "enabled", "string", false, "INBOX", "Pasta base retornar as mensagens."], |
---|
104 | msgID :["text", "enabled", "string", false, "", "ID da mensagem."], |
---|
105 | search :["text", "enabled", "string", false, "", "Buscar pastas com o nome."], |
---|
106 | resultsPerPage :["text", "enabled", "int", true, "10", "Resultados por página."], |
---|
107 | page :["text", "enabled", "int", true, "1", "Página Atual."] |
---|
108 | } |
---|
109 | }, |
---|
110 | |
---|
111 | mail_attachment : |
---|
112 | { |
---|
113 | apps : ["mail"], |
---|
114 | id : "mail_attachment", |
---|
115 | description : "Retorna o anexo da mensagem para download", |
---|
116 | method : ["POST"], |
---|
117 | rest : "Mail/Attachment", |
---|
118 | click : "execute.ajax('mail_attachment')", |
---|
119 | params : |
---|
120 | { |
---|
121 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
122 | folderID :["text", "enabled", "string", false, "", "Pasta onde está localizada a mensagem."], |
---|
123 | messageID :["text", "enabled", "string", false, "", "ID da mensagem na pasta."], |
---|
124 | attachmentID :["text", "enabled", "string", false, "", "ID do anexo da mensagem."], |
---|
125 | } |
---|
126 | }, |
---|
127 | |
---|
128 | mail_send: |
---|
129 | { |
---|
130 | apps :["mail"], |
---|
131 | id : "mail_send", |
---|
132 | description : "Envia uma mensagem de email.", |
---|
133 | method : ["POST"], |
---|
134 | rest : "Mail/Send", |
---|
135 | click : "execute.ajax('mail_send')", |
---|
136 | params : |
---|
137 | { |
---|
138 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
139 | msgTo :["text", "enabled", "string", true, "", "Enviar mensagem para."], |
---|
140 | msgCc :["text", "enabled", "string", false, "", "Enviar mensagem com cópia para."], |
---|
141 | msgBcc :["text", "enabled", "string", false, "", "Enviar mensagem com cópia oculta para."], |
---|
142 | msgSubject :["text", "enabled", "string", true, "", "Assunto da mensagem."], |
---|
143 | msgBody :["text", "enabled", "string", true, "", "Conteúdo da mensagem."] |
---|
144 | } |
---|
145 | }, |
---|
146 | |
---|
147 | mail_rename_folder: |
---|
148 | { |
---|
149 | apps : ["mail"], |
---|
150 | id : "mail_rename_folder", |
---|
151 | description : "Renomeia uma pasta, recebe como parametros o \"folderID\" da pasta a ser renomeada, e o nome da nova pasta \"folderName\"", |
---|
152 | method : ["POST"], |
---|
153 | rest : "Mail/RenameFolder", |
---|
154 | click : "execute.ajax('mail_rename_folder')", |
---|
155 | params : |
---|
156 | { |
---|
157 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
158 | folderID :["text", "enabled", "string", true, "", "ID (folderID) da pasta que será renomeada"], |
---|
159 | folderName :["text", "enabled", "string", true, "", "Nome da nova Pasta"] |
---|
160 | } |
---|
161 | }, |
---|
162 | |
---|
163 | mail_del_folder: |
---|
164 | { |
---|
165 | apps : ["mail"], |
---|
166 | id : "mail_del_folder", |
---|
167 | description : "Exclui uma pasta. Recebe como parametros o \"folderID\" da pasta que será excluída. Obs: Somente exclui a pasta se não houver mensagens dentro dela.", |
---|
168 | method : ["POST"], |
---|
169 | rest : "Mail/DelFolder", |
---|
170 | click : "execute.ajax('mail_del_folder')", |
---|
171 | params : |
---|
172 | { |
---|
173 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
174 | folderID :["text", "enabled", "string", true, "", "ID (folderID) da pasta que será excluida."] |
---|
175 | } |
---|
176 | |
---|
177 | }, |
---|
178 | |
---|
179 | mail_clean_trash: |
---|
180 | { |
---|
181 | apps : ["mail"], |
---|
182 | id : "mail_clean_trash", |
---|
183 | description : "Limpa a Lixeira do Usuário", |
---|
184 | method : ["POST"], |
---|
185 | rest : "Mail/CleanTrash", |
---|
186 | click : "execute.ajax('mail_clean_trash')", |
---|
187 | params : |
---|
188 | { |
---|
189 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."] |
---|
190 | } |
---|
191 | }, |
---|
192 | |
---|
193 | mail_send_support_feedback: |
---|
194 | { |
---|
195 | apps : ["mail"], |
---|
196 | id : "mail_send_support_feedback", |
---|
197 | description : "Envia uma mensagem de Sugestão para o administrador do Expresso.", |
---|
198 | method : ["POST"], |
---|
199 | rest : "Mail/SendSupportFeedback", |
---|
200 | click : "execute.ajax('mail_send_support_feedback')", |
---|
201 | params : |
---|
202 | { |
---|
203 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
204 | message :["text", "enabled", "string", true, "", "Mensagem de sugestão a ser enviada para o suporte do Expresso."] |
---|
205 | } |
---|
206 | }, |
---|
207 | |
---|
208 | catalog_contacts: |
---|
209 | { |
---|
210 | apps : ["catalog"], |
---|
211 | id : "catalog_contacts", |
---|
212 | description : "Retorna os contatos do Catálogo Pessoal e Geral, recebe como parametros o \"search\" como parametro de busca e o contactType (1-Pessoal, 2-Catálogo Geral)", |
---|
213 | method : ["POST"], |
---|
214 | rest : "Catalog/Contacts", |
---|
215 | click : "execute.ajax('catalog_contacts')", |
---|
216 | params : |
---|
217 | { |
---|
218 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."], |
---|
219 | search :["text", "enabled", "string", false, "", "Buscar contatos pelo nome"], |
---|
220 | contactType :["text", "enabled", "string", true, "", "Tipo do contato a ser buscado (1-Pessoal, 2-Catálogo Geral)."] |
---|
221 | } |
---|
222 | }, |
---|
223 | |
---|
224 | catalog_contact_picture: |
---|
225 | { |
---|
226 | apps : ["catalog"], |
---|
227 | id : "catalog_contact_picture", |
---|
228 | description : "Retorna a foto de um contato em BASE64. Recebe como parametros o \"contactID\" e o \"contactType\" (1-Pessoal, 2-Catálogo Geral).", |
---|
229 | method : ["POST"], |
---|
230 | rest : "Catalog/ContactPicture", |
---|
231 | click : "execute.ajax('catalog_contact_picture')", |
---|
232 | params : |
---|
233 | { |
---|
234 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
235 | contactID :["text", "enabled", "string", false, "", "ID do Contato que será retornado a foto"], |
---|
236 | contactType :["text", "enabled", "string", false, "1", "Tipo do contato a ser buscado (1-Pessoal, 2-Catálogo Geral)" ] |
---|
237 | } |
---|
238 | |
---|
239 | }, |
---|
240 | |
---|
241 | calendar_events: |
---|
242 | { |
---|
243 | apps : ["calendar"], |
---|
244 | id : "calendar_events", |
---|
245 | description : "Retorna os Eventos do Calendário, Recebe como parametro a data inicial \"dateStart\" e a data final \"dateEnd\" e retorna todos os eventos no periodo.", |
---|
246 | method : ["POST"], |
---|
247 | rest : "Calendar/Events", |
---|
248 | click : "execute.ajax('calendar_events')", |
---|
249 | params : |
---|
250 | { |
---|
251 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
252 | dateStart :["text", "enabled", "string", true, "", "Data inicial de consulta da agenda(DD/MM/YYYY)"], |
---|
253 | dateEnd :["text", "enabled", "string", true, "", "Data final de consulta da agenda(DD/MM/YYYY)"] |
---|
254 | } |
---|
255 | }, |
---|
256 | |
---|
257 | admin_create_user: |
---|
258 | { |
---|
259 | apps : ["admin"], |
---|
260 | id : "admin_create_user", |
---|
261 | description : "Cria um usuário no Expresso, necessário ter a permissão no Módulo ExpressoAdmin", |
---|
262 | method : ["POST"], |
---|
263 | rest : "Admin/CreateUser", |
---|
264 | click : "execute.ajax('admin_create_user')", |
---|
265 | params : |
---|
266 | { |
---|
267 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
268 | accountLogin :["text", "enabled", "string", true, "", "Login do usuário"], |
---|
269 | accountEmail :["text", "enabled", "string", true, "", "Email do usuário"], |
---|
270 | accountName :["text", "enabled", "string", true, "", "Nome do usuário"], |
---|
271 | accountProfile :["text", "enabled", "string", true, "", "Perfil do usuário( Verifique se o perfil está disponível no servidor)"], |
---|
272 | accountPassword :["password", "enabled", "string", true, "", "Senha do usuário"], |
---|
273 | accountRePassword :["password", "enabled", "string", true, "", "Confirmação da senha do usuário"], |
---|
274 | accountPhone :["text", "enabled", "string", true, "", "Telefone do usuário. Máscara padrão (00)0000-0000"], |
---|
275 | accountCpf :["text", "enabled", "string", true, "", "CPF do usuário. Máscara padrão 000.000.000-00"], |
---|
276 | accountRg :["text", "enabled", "string", true, "", "RG do usuário"], |
---|
277 | accountRgUf :["text", "enabled", "string", true, "", "UF"], |
---|
278 | accountBirthDate :["text", "enabled", "string", true, "", "Data de aniversário do usuário. Máscara padrão DD/MM/AAAA"], |
---|
279 | accountSex :["text", "enabled", "string", true, "", "Sexo"], |
---|
280 | accountCity :["text", "enabled", "string", true, "", "Cidade"], |
---|
281 | accountSt :["text", "enabled", "string", true, "", "Estado"], |
---|
282 | accountDescription :["text", "enabled", "string", true, "", "Descrição do usuário"] |
---|
283 | } |
---|
284 | }, |
---|
285 | |
---|
286 | admin_get_users: |
---|
287 | { |
---|
288 | apps : ["admin"], |
---|
289 | id : "admin_get_users", |
---|
290 | description : "Faz a busca do(s) usuário(s) no Expresso, necessário ter a permissão no Módulo ExpressoAdmin", |
---|
291 | method :[ "POST" ], |
---|
292 | rest : "Admin/GetUsers", |
---|
293 | click : "execute.ajax('admin_get_users')", |
---|
294 | params : |
---|
295 | { |
---|
296 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
297 | accountUidNumber :["text", "enabled", "string", false, "", "UIDNumber do usuário para edição"], |
---|
298 | accountSearchUser :["text", "enabled", "string", false, "", "Procurar usuários por nome, email, uid ( igual ao módulo admin do expresso )"], |
---|
299 | accountSearchUserLID :["text", "enabled", "string", false, "", "Procurar usuários somente por uid( igual ao módulo admin do expresso )"] |
---|
300 | } |
---|
301 | }, |
---|
302 | |
---|
303 | admin_delete_user: |
---|
304 | { |
---|
305 | apps : ["admin"], |
---|
306 | id : "admin_delete_user", |
---|
307 | description : "Exclui um usário no Expresso, necessário ter a permissão no Módulo ExpressoAdmin", |
---|
308 | method : ["POST"], |
---|
309 | rest : "Admin/DeleteUser", |
---|
310 | click : "execute.ajax('admin_delete_user')", |
---|
311 | params : |
---|
312 | { |
---|
313 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
314 | accountUid :["text", "enabled", "string", true, "", "UID do usuário" ], |
---|
315 | accountUidNumber :["text", "enabled", "string", true, "", "UIDNumber do usuário"] |
---|
316 | } |
---|
317 | }, |
---|
318 | |
---|
319 | admin_rename_user: |
---|
320 | { |
---|
321 | apps : ["admin"], |
---|
322 | id : "admin_rename_user", |
---|
323 | description : "Renomeia um usuário no Expresso, necessário ter a permissão no Módulo ExpressoAdmin", |
---|
324 | method : ["POST"], |
---|
325 | rest : "Admin/RenameUser", |
---|
326 | click : "execute.ajax('admin_rename_user')", |
---|
327 | params : |
---|
328 | { |
---|
329 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
330 | accountUidRename :["text", "enabled", "string", true, "", "UID do usuário a ser renomeado."], |
---|
331 | accountUidNewRename :["text", "enabled", "string", true, "", "Novo UID do usuário ser renomeado."] |
---|
332 | } |
---|
333 | }, |
---|
334 | |
---|
335 | admin_update_user: |
---|
336 | { |
---|
337 | apps : ["admin"], |
---|
338 | id : "admin_update_user", |
---|
339 | description : "Atualiza um usuário no Expresso, necessário ter a permissão no Módulo ExpressoAdmin", |
---|
340 | method : ["POST"], |
---|
341 | rest : "Admin/UpdateUser", |
---|
342 | click : "execute.ajax('admin_update_user')", |
---|
343 | params : |
---|
344 | { |
---|
345 | auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], |
---|
346 | accountUidNumber :["text", "enabled", "string", true, "", "UIDNumber do usuário"], |
---|
347 | accountLogin :["text", "enabled", "string", true, "", "Login do usuário"], |
---|
348 | accountEmail :["text", "enabled", "string", false, "", "Email do usuário"], |
---|
349 | accountName :["text", "enabled", "string", false, "", "Nome do usuário"], |
---|
350 | accountPassword :["password", "enabled", "string", false, "", "Senha do usuário"], |
---|
351 | accountRePassword :["password", "enabled", "string", false, "", "Confirmação do usuário"], |
---|
352 | accountPhone :["text", "enabled", "string", false, "", "Telefone do usuário. Máscara padrão (00)0000-0000"], |
---|
353 | accountCpf :["text", "enabled", "string", false, "", "CPF do usuário. Máscara padrão 000.000.000-00"], |
---|
354 | accountRg :["text", "enabled", "string", false, "", "RG do usuário"], |
---|
355 | accountRgUf :["text", "enabled", "string", false, "", "UF"], |
---|
356 | accountDescription :["text", "enabled", "string", false, "", "Descrição do usuário"], |
---|
357 | accountMailQuota :["text", "enabled", "string", false, "", "Cota de e-mail em MB"] |
---|
358 | } |
---|
359 | } |
---|
360 | }; |
---|
361 | // END Resources |
---|