@in.pulse-crm/sdk 2.11.3 → 2.11.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,66 +1,66 @@
1
- // src/types/socket-rooms.types.ts
2
- type ReportType = "chats";
3
- type ChatId = number;
4
- type InternalChatId = number;
5
- type WalletId = number;
6
- type UserId = number;
7
- type SectorId = number;
8
- type InstanceName = string;
9
-
10
- /*
11
- Salas de Socket do lado do cliente;
12
- Essas salas omitem o nome da instancia e/ou id do setor,
13
- pois isso é controlado pelo servidor;
14
- */
15
- export type SocketClientChatRoom = `chat:${ChatId}`;
16
- export type SocketClientAdminRoom = "admin";
17
- export type SocketClientMonitorRoom = `monitor`;
18
- export type SocketClientReportsRoom = `reports:${ReportType}`;
19
- export type SocketClientWalletRoom = `wallet:${WalletId}`;
20
- export type SocketClientUserRoom = `user:${UserId}`;
21
- export type SocketClientInternalChatRoom = `internal-chat:${InternalChatId}`;
22
- export type SocketClientRoom =
23
- | SocketClientChatRoom
24
- | SocketClientAdminRoom
25
- | SocketClientReportsRoom
26
- | SocketClientMonitorRoom
27
- | SocketClientWalletRoom
28
- | SocketClientUserRoom
29
- | SocketClientInternalChatRoom;
30
-
31
- // Interface que incluí o nome da instancia na sala de socket;
32
- type SocketRoomWithInstance<T extends string> = `${InstanceName}:${T}`;
33
-
34
- // Interface que incluí o nome da instancia e o id do setor na sala de socket;
35
- type SocketRoomWithSector<T extends string> =
36
- SocketRoomWithInstance<`${SectorId}:${T}`>;
37
-
38
- /*
39
- Salas de Socket do lado do servidor;
40
- Essas salas incluem o nome da instancia e o id do setor,
41
- Permitindo que cada instancia consiga ver apenas o que lhe
42
- pertence, e não as salas de outras instancias.
43
- */
44
- export type SocketServerAdminRoom = SocketRoomWithSector<SocketClientAdminRoom>;
45
- export type SocketServerMonitorRoom =
46
- SocketRoomWithSector<SocketClientMonitorRoom>;
47
- export type SocketServerReportsRoom =
48
- SocketRoomWithSector<SocketClientReportsRoom>;
49
- export type SocketServerChatRoom = SocketRoomWithInstance<SocketClientChatRoom>;
50
- export type SocketServerWalletRoom =
51
- SocketRoomWithInstance<SocketClientWalletRoom>;
52
- export type SocketServerUserRoom = SocketRoomWithInstance<SocketClientUserRoom>;
53
- export type SocketServerInternalChatRoom =
54
- SocketRoomWithInstance<SocketClientInternalChatRoom>;
55
- export type SocketServerRoom =
56
- | SocketServerChatRoom
57
- | SocketServerAdminRoom
58
- | SocketServerMonitorRoom
59
- | SocketServerReportsRoom
60
- | SocketServerWalletRoom
61
- | SocketServerUserRoom
62
- | SocketServerInternalChatRoom;
63
-
64
- export interface JoinRoomFn {
65
- (room: SocketClientRoom): void;
66
- }
1
+ // src/types/socket-rooms.types.ts
2
+ type ReportType = "chats";
3
+ type ChatId = number;
4
+ type InternalChatId = number;
5
+ type WalletId = number;
6
+ type UserId = number;
7
+ type SectorId = number;
8
+ type InstanceName = string;
9
+
10
+ /*
11
+ Salas de Socket do lado do cliente;
12
+ Essas salas omitem o nome da instancia e/ou id do setor,
13
+ pois isso é controlado pelo servidor;
14
+ */
15
+ export type SocketClientChatRoom = `chat:${ChatId}`;
16
+ export type SocketClientAdminRoom = "admin";
17
+ export type SocketClientMonitorRoom = `monitor`;
18
+ export type SocketClientReportsRoom = `reports:${ReportType}`;
19
+ export type SocketClientWalletRoom = `wallet:${WalletId}`;
20
+ export type SocketClientUserRoom = `user:${UserId}`;
21
+ export type SocketClientInternalChatRoom = `internal-chat:${InternalChatId}`;
22
+ export type SocketClientRoom =
23
+ | SocketClientChatRoom
24
+ | SocketClientAdminRoom
25
+ | SocketClientReportsRoom
26
+ | SocketClientMonitorRoom
27
+ | SocketClientWalletRoom
28
+ | SocketClientUserRoom
29
+ | SocketClientInternalChatRoom;
30
+
31
+ // Interface que incluí o nome da instancia na sala de socket;
32
+ type SocketRoomWithInstance<T extends string> = `${InstanceName}:${T}`;
33
+
34
+ // Interface que incluí o nome da instancia e o id do setor na sala de socket;
35
+ type SocketRoomWithSector<T extends string> =
36
+ SocketRoomWithInstance<`${SectorId}:${T}`>;
37
+
38
+ /*
39
+ Salas de Socket do lado do servidor;
40
+ Essas salas incluem o nome da instancia e o id do setor,
41
+ Permitindo que cada instancia consiga ver apenas o que lhe
42
+ pertence, e não as salas de outras instancias.
43
+ */
44
+ export type SocketServerAdminRoom = SocketRoomWithSector<SocketClientAdminRoom>;
45
+ export type SocketServerMonitorRoom =
46
+ SocketRoomWithSector<SocketClientMonitorRoom>;
47
+ export type SocketServerReportsRoom =
48
+ SocketRoomWithSector<SocketClientReportsRoom>;
49
+ export type SocketServerChatRoom = SocketRoomWithInstance<SocketClientChatRoom>;
50
+ export type SocketServerWalletRoom =
51
+ SocketRoomWithInstance<SocketClientWalletRoom>;
52
+ export type SocketServerUserRoom = SocketRoomWithInstance<SocketClientUserRoom>;
53
+ export type SocketServerInternalChatRoom =
54
+ SocketRoomWithInstance<SocketClientInternalChatRoom>;
55
+ export type SocketServerRoom =
56
+ | SocketServerChatRoom
57
+ | SocketServerAdminRoom
58
+ | SocketServerMonitorRoom
59
+ | SocketServerReportsRoom
60
+ | SocketServerWalletRoom
61
+ | SocketServerUserRoom
62
+ | SocketServerInternalChatRoom;
63
+
64
+ export interface JoinRoomFn {
65
+ (room: SocketClientRoom): void;
66
+ }
@@ -1,163 +1,163 @@
1
- /**
2
- * Enum que representa os diferentes papéis de usuário dentro do sistema.
3
- *
4
- * @enum {string}
5
- * @property {string} ADMIN - Representa um papel de administrador.
6
- * @property {string} ACTIVE - Representa um papel de usuário ativo.
7
- * @property {string} RECEPTIONIST - Representa um papel de recepcionista.
8
- * @property {string} BOTH - Representa um papel que combina tanto recepcionista quanto usuário ativo.
9
- */
10
- export enum UserRole {
11
- ADMIN = "ADMIN",
12
- ACTIVE = "ATIVO",
13
- RECEPTIONIST = "RECEP",
14
- BOTH = "AMBOS",
15
- }
16
-
17
- /**
18
- * Interface que representa um usuário do Inpulse.
19
- */
20
- export interface User {
21
- /** Código do usuário */
22
- CODIGO: number;
23
- /** Indica se o usuário está ativo */
24
- ATIVO: "SIM" | "NAO" | null;
25
- /** Nome do usuário */
26
- NOME: string;
27
- /** Login do usuário */
28
- LOGIN: string;
29
- /** Email do usuário */
30
- EMAIL: string | null;
31
- WHATSAPP?: string | null;
32
- /** Nível de acesso do usuário */
33
- NIVEL: UserRole | null;
34
- /** Horário de trabalho do usuário */
35
- HORARIO: number;
36
- /** Data de cadastro do usuário */
37
- DATACAD: Date | null;
38
- /** Código do setor do usuário */
39
- SETOR: number;
40
- /** Nome de exibição do usuário */
41
- NOME_EXIBICAO: string | null;
42
- /** Código ERP do usuário */
43
- CODIGO_ERP: string;
44
- /** Nome do setor do usuário */
45
- SETOR_NOME: string;
46
- /** Senha do usuário */
47
- SENHA?: string | null;
48
- /** Data de expiração da senha do usuário */
49
- EXPIRA_EM: Date | null;
50
- /** Indica se o usuário deve alterar a senha */
51
- ALTERA_SENHA: "SIM" | "NAO" | null;
52
- /** Indica se o usuário pode editar contatos */
53
- EDITA_CONTATOS: "SIM" | "NAO" | null;
54
- /** Indica se o usuário pode visualizar compras */
55
- VISUALIZA_COMPRAS: "SIM" | "NAO" | null;
56
- /** Tipo de cadastro do usuário */
57
- CADASTRO: "TOTAL" | "NULOS" | null;
58
- /** Indica se o usuário está logado */
59
- LOGADO: number | null;
60
- /** Data e hora do início do último login */
61
- ULTIMO_LOGIN_INI: Date | null;
62
- /** Data e hora do fim do último login */
63
- ULTIMO_LOGIN_FIM: Date | null;
64
- /** Código de telefonia do usuário */
65
- CODTELEFONIA: string;
66
- /** Indica se o usuário agenda ligações */
67
- AGENDA_LIG: "SIM" | "NAO";
68
- /** Indica se o usuário liga para representantes */
69
- LIGA_REPRESENTANTE: "SIM" | "NAO";
70
- /** Banco do usuário */
71
- BANCO: string;
72
- /** Indica se o usuário filtra por DDD */
73
- FILTRA_DDD: "SIM" | "NAO";
74
- /** Indica se o usuário filtra por estado */
75
- FILTRA_ESTADO: "SIM" | "NAO";
76
- /** Ramal do Asterisk do usuário */
77
- ASTERISK_RAMAL: string | null;
78
- /** UserID do Asterisk do usuário */
79
- ASTERISK_USERID: string | null;
80
- /** Login do Asterisk do usuário */
81
- ASTERISK_LOGIN: string | null;
82
- /** Senha do Asterisk do usuário */
83
- ASTERISK_SENHA: string | null;
84
- /** Codec do Asterisk do usuário */
85
- CODEC: string | null;
86
- /** Assinatura de email do usuário */
87
- ASSINATURA_EMAIL: string | null;
88
- /** Dias para ligar para representantes */
89
- LIGA_REPRESENTANTE_DIAS: number | null;
90
- /** Email do operador */
91
- EMAILOPERADOR: string | null;
92
- /** Senha do email do operador */
93
- SENHAEMAILOPERADOR: string | null;
94
- /** Email de exibição do usuário */
95
- EMAIL_EXIBICAO: string | null;
96
- /** Limite diário de agendamento */
97
- limite_diario_agendamento: number | null;
98
- /** Indica se o usuário é omni */
99
- OMNI: number | null;
100
- /** Caminho do banco de dados */
101
- CAMINHO_DATABASE: string | null;
102
- /** ID da campanha WeOn */
103
- IDCAMPANHA_WEON: string | null;
104
- AVATAR_ID: number | null;
105
- }
106
-
107
- /**
108
- * Interface que representa o objeto de transferência de dados para criar um usuário.
109
- */
110
- export interface CreateUserDTO {
111
- /**
112
- * O nome do usuário.
113
- */
114
- NOME: string;
115
-
116
- /**
117
- * O nome de usuário para login.
118
- */
119
- LOGIN: string;
120
-
121
- /**
122
- * A senha do usuário.
123
- */
124
- SENHA: string;
125
-
126
- /**
127
- * O nível de acesso do usuário.
128
- * Pode ser um dos seguintes valores:
129
- * - "ATIVO"
130
- * - "RECEP"
131
- * - "AMBOS"
132
- * - "ADMIN"
133
- */
134
- NIVEL: UserRole;
135
-
136
- /**
137
- * O número do setor do usuário.
138
- */
139
- SETOR: number;
140
-
141
- /**
142
- * O endereço de email do usuário (opcional).
143
- */
144
- EMAIL?: string;
145
-
146
- WHATSAPP?: string;
147
-
148
- /**
149
- * O nome de exibição do usuário (opcional).
150
- */
151
- NOME_EXIBICAO?: string;
152
-
153
- /**
154
- * O código ERP do usuário (opcional).
155
- */
156
- CODIGO_ERP?: string;
157
- AVATAR_ID?: number | null;
158
- }
159
-
160
- /**
161
- * Interface que representa o objeto de transferência de dados para atualizar um usuário.
162
- */
1
+ /**
2
+ * Enum que representa os diferentes papéis de usuário dentro do sistema.
3
+ *
4
+ * @enum {string}
5
+ * @property {string} ADMIN - Representa um papel de administrador.
6
+ * @property {string} ACTIVE - Representa um papel de usuário ativo.
7
+ * @property {string} RECEPTIONIST - Representa um papel de recepcionista.
8
+ * @property {string} BOTH - Representa um papel que combina tanto recepcionista quanto usuário ativo.
9
+ */
10
+ export enum UserRole {
11
+ ADMIN = "ADMIN",
12
+ ACTIVE = "ATIVO",
13
+ RECEPTIONIST = "RECEP",
14
+ BOTH = "AMBOS",
15
+ }
16
+
17
+ /**
18
+ * Interface que representa um usuário do Inpulse.
19
+ */
20
+ export interface User {
21
+ /** Código do usuário */
22
+ CODIGO: number;
23
+ /** Indica se o usuário está ativo */
24
+ ATIVO: "SIM" | "NAO" | null;
25
+ /** Nome do usuário */
26
+ NOME: string;
27
+ /** Login do usuário */
28
+ LOGIN: string;
29
+ /** Email do usuário */
30
+ EMAIL: string | null;
31
+ WHATSAPP?: string | null;
32
+ /** Nível de acesso do usuário */
33
+ NIVEL: UserRole | null;
34
+ /** Horário de trabalho do usuário */
35
+ HORARIO: number;
36
+ /** Data de cadastro do usuário */
37
+ DATACAD: Date | null;
38
+ /** Código do setor do usuário */
39
+ SETOR: number;
40
+ /** Nome de exibição do usuário */
41
+ NOME_EXIBICAO: string | null;
42
+ /** Código ERP do usuário */
43
+ CODIGO_ERP: string;
44
+ /** Nome do setor do usuário */
45
+ SETOR_NOME: string;
46
+ /** Senha do usuário */
47
+ SENHA?: string | null;
48
+ /** Data de expiração da senha do usuário */
49
+ EXPIRA_EM: Date | null;
50
+ /** Indica se o usuário deve alterar a senha */
51
+ ALTERA_SENHA: "SIM" | "NAO" | null;
52
+ /** Indica se o usuário pode editar contatos */
53
+ EDITA_CONTATOS: "SIM" | "NAO" | null;
54
+ /** Indica se o usuário pode visualizar compras */
55
+ VISUALIZA_COMPRAS: "SIM" | "NAO" | null;
56
+ /** Tipo de cadastro do usuário */
57
+ CADASTRO: "TOTAL" | "NULOS" | null;
58
+ /** Indica se o usuário está logado */
59
+ LOGADO: number | null;
60
+ /** Data e hora do início do último login */
61
+ ULTIMO_LOGIN_INI: Date | null;
62
+ /** Data e hora do fim do último login */
63
+ ULTIMO_LOGIN_FIM: Date | null;
64
+ /** Código de telefonia do usuário */
65
+ CODTELEFONIA: string;
66
+ /** Indica se o usuário agenda ligações */
67
+ AGENDA_LIG: "SIM" | "NAO";
68
+ /** Indica se o usuário liga para representantes */
69
+ LIGA_REPRESENTANTE: "SIM" | "NAO";
70
+ /** Banco do usuário */
71
+ BANCO: string;
72
+ /** Indica se o usuário filtra por DDD */
73
+ FILTRA_DDD: "SIM" | "NAO";
74
+ /** Indica se o usuário filtra por estado */
75
+ FILTRA_ESTADO: "SIM" | "NAO";
76
+ /** Ramal do Asterisk do usuário */
77
+ ASTERISK_RAMAL: string | null;
78
+ /** UserID do Asterisk do usuário */
79
+ ASTERISK_USERID: string | null;
80
+ /** Login do Asterisk do usuário */
81
+ ASTERISK_LOGIN: string | null;
82
+ /** Senha do Asterisk do usuário */
83
+ ASTERISK_SENHA: string | null;
84
+ /** Codec do Asterisk do usuário */
85
+ CODEC: string | null;
86
+ /** Assinatura de email do usuário */
87
+ ASSINATURA_EMAIL: string | null;
88
+ /** Dias para ligar para representantes */
89
+ LIGA_REPRESENTANTE_DIAS: number | null;
90
+ /** Email do operador */
91
+ EMAILOPERADOR: string | null;
92
+ /** Senha do email do operador */
93
+ SENHAEMAILOPERADOR: string | null;
94
+ /** Email de exibição do usuário */
95
+ EMAIL_EXIBICAO: string | null;
96
+ /** Limite diário de agendamento */
97
+ limite_diario_agendamento: number | null;
98
+ /** Indica se o usuário é omni */
99
+ OMNI: number | null;
100
+ /** Caminho do banco de dados */
101
+ CAMINHO_DATABASE: string | null;
102
+ /** ID da campanha WeOn */
103
+ IDCAMPANHA_WEON: string | null;
104
+ AVATAR_ID: number | null;
105
+ }
106
+
107
+ /**
108
+ * Interface que representa o objeto de transferência de dados para criar um usuário.
109
+ */
110
+ export interface CreateUserDTO {
111
+ /**
112
+ * O nome do usuário.
113
+ */
114
+ NOME: string;
115
+
116
+ /**
117
+ * O nome de usuário para login.
118
+ */
119
+ LOGIN: string;
120
+
121
+ /**
122
+ * A senha do usuário.
123
+ */
124
+ SENHA: string;
125
+
126
+ /**
127
+ * O nível de acesso do usuário.
128
+ * Pode ser um dos seguintes valores:
129
+ * - "ATIVO"
130
+ * - "RECEP"
131
+ * - "AMBOS"
132
+ * - "ADMIN"
133
+ */
134
+ NIVEL: UserRole;
135
+
136
+ /**
137
+ * O número do setor do usuário.
138
+ */
139
+ SETOR: number;
140
+
141
+ /**
142
+ * O endereço de email do usuário (opcional).
143
+ */
144
+ EMAIL?: string;
145
+
146
+ WHATSAPP?: string;
147
+
148
+ /**
149
+ * O nome de exibição do usuário (opcional).
150
+ */
151
+ NOME_EXIBICAO?: string;
152
+
153
+ /**
154
+ * O código ERP do usuário (opcional).
155
+ */
156
+ CODIGO_ERP?: string;
157
+ AVATAR_ID?: number | null;
158
+ }
159
+
160
+ /**
161
+ * Interface que representa o objeto de transferência de dados para atualizar um usuário.
162
+ */
163
163
  export type UpdateUserDTO = Partial<CreateUserDTO>;
@@ -1,6 +1,6 @@
1
- export interface Wallet {
2
- id: number,
3
- instance: string,
4
- name: string,
5
- userIds: number[]
1
+ export interface Wallet {
2
+ id: number,
3
+ instance: string,
4
+ name: string,
5
+ userIds: number[]
6
6
  }