zudello-chat-sdk 0.1.1
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.
- package/README.md +325 -0
- package/dist/cjs/client.js +124 -0
- package/dist/cjs/client.js.map +1 -0
- package/dist/cjs/constants.js +578 -0
- package/dist/cjs/constants.js.map +1 -0
- package/dist/cjs/errors.js +195 -0
- package/dist/cjs/errors.js.map +1 -0
- package/dist/cjs/http/client.js +218 -0
- package/dist/cjs/http/client.js.map +1 -0
- package/dist/cjs/index.js +80 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/modules/approvals.js +90 -0
- package/dist/cjs/modules/approvals.js.map +1 -0
- package/dist/cjs/modules/automation.js +110 -0
- package/dist/cjs/modules/automation.js.map +1 -0
- package/dist/cjs/modules/config.js +264 -0
- package/dist/cjs/modules/config.js.map +1 -0
- package/dist/cjs/modules/datasets.js +103 -0
- package/dist/cjs/modules/datasets.js.map +1 -0
- package/dist/cjs/modules/exports.js +126 -0
- package/dist/cjs/modules/exports.js.map +1 -0
- package/dist/cjs/modules/inboxes.js +99 -0
- package/dist/cjs/modules/inboxes.js.map +1 -0
- package/dist/cjs/modules/models.js +105 -0
- package/dist/cjs/modules/models.js.map +1 -0
- package/dist/cjs/modules/org.js +335 -0
- package/dist/cjs/modules/org.js.map +1 -0
- package/dist/cjs/modules/quick-actions.js +71 -0
- package/dist/cjs/modules/quick-actions.js.map +1 -0
- package/dist/cjs/modules/resources.js +236 -0
- package/dist/cjs/modules/resources.js.map +1 -0
- package/dist/cjs/modules/search.js +188 -0
- package/dist/cjs/modules/search.js.map +1 -0
- package/dist/cjs/modules/sentences.js +155 -0
- package/dist/cjs/modules/sentences.js.map +1 -0
- package/dist/cjs/modules/users.js +120 -0
- package/dist/cjs/modules/users.js.map +1 -0
- package/dist/cjs/types.js +8 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/esm/client.js +120 -0
- package/dist/esm/client.js.map +1 -0
- package/dist/esm/constants.js +565 -0
- package/dist/esm/constants.js.map +1 -0
- package/dist/esm/errors.js +183 -0
- package/dist/esm/errors.js.map +1 -0
- package/dist/esm/http/client.js +214 -0
- package/dist/esm/http/client.js.map +1 -0
- package/dist/esm/index.js +49 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/modules/approvals.js +86 -0
- package/dist/esm/modules/approvals.js.map +1 -0
- package/dist/esm/modules/automation.js +106 -0
- package/dist/esm/modules/automation.js.map +1 -0
- package/dist/esm/modules/config.js +260 -0
- package/dist/esm/modules/config.js.map +1 -0
- package/dist/esm/modules/datasets.js +99 -0
- package/dist/esm/modules/datasets.js.map +1 -0
- package/dist/esm/modules/exports.js +122 -0
- package/dist/esm/modules/exports.js.map +1 -0
- package/dist/esm/modules/inboxes.js +95 -0
- package/dist/esm/modules/inboxes.js.map +1 -0
- package/dist/esm/modules/models.js +101 -0
- package/dist/esm/modules/models.js.map +1 -0
- package/dist/esm/modules/org.js +331 -0
- package/dist/esm/modules/org.js.map +1 -0
- package/dist/esm/modules/quick-actions.js +67 -0
- package/dist/esm/modules/quick-actions.js.map +1 -0
- package/dist/esm/modules/resources.js +232 -0
- package/dist/esm/modules/resources.js.map +1 -0
- package/dist/esm/modules/search.js +184 -0
- package/dist/esm/modules/search.js.map +1 -0
- package/dist/esm/modules/sentences.js +151 -0
- package/dist/esm/modules/sentences.js.map +1 -0
- package/dist/esm/modules/users.js +116 -0
- package/dist/esm/modules/users.js.map +1 -0
- package/dist/esm/types.js +7 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/types/client.d.ts +105 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/constants.d.ts +505 -0
- package/dist/types/constants.d.ts.map +1 -0
- package/dist/types/errors.d.ts +143 -0
- package/dist/types/errors.d.ts.map +1 -0
- package/dist/types/http/client.d.ts +42 -0
- package/dist/types/http/client.d.ts.map +1 -0
- package/dist/types/index.d.ts +37 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/modules/approvals.d.ts +62 -0
- package/dist/types/modules/approvals.d.ts.map +1 -0
- package/dist/types/modules/automation.d.ts +79 -0
- package/dist/types/modules/automation.d.ts.map +1 -0
- package/dist/types/modules/config.d.ts +173 -0
- package/dist/types/modules/config.d.ts.map +1 -0
- package/dist/types/modules/datasets.d.ts +55 -0
- package/dist/types/modules/datasets.d.ts.map +1 -0
- package/dist/types/modules/exports.d.ts +76 -0
- package/dist/types/modules/exports.d.ts.map +1 -0
- package/dist/types/modules/inboxes.d.ts +91 -0
- package/dist/types/modules/inboxes.d.ts.map +1 -0
- package/dist/types/modules/models.d.ts +91 -0
- package/dist/types/modules/models.d.ts.map +1 -0
- package/dist/types/modules/org.d.ts +122 -0
- package/dist/types/modules/org.d.ts.map +1 -0
- package/dist/types/modules/quick-actions.d.ts +58 -0
- package/dist/types/modules/quick-actions.d.ts.map +1 -0
- package/dist/types/modules/resources.d.ts +111 -0
- package/dist/types/modules/resources.d.ts.map +1 -0
- package/dist/types/modules/search.d.ts +72 -0
- package/dist/types/modules/search.d.ts.map +1 -0
- package/dist/types/modules/sentences.d.ts +105 -0
- package/dist/types/modules/sentences.d.ts.map +1 -0
- package/dist/types/modules/users.d.ts +65 -0
- package/dist/types/modules/users.d.ts.map +1 -0
- package/dist/types/types.d.ts +2056 -0
- package/dist/types/types.d.ts.map +1 -0
- package/package.json +67 -0
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Models Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for introspecting Zudello data models.
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { ModelSchema, ModelMetadata } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Model introspection operations for Zudello.
|
|
10
|
+
*/
|
|
11
|
+
export declare class ModelsModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* List all available models.
|
|
16
|
+
*
|
|
17
|
+
* @returns Promise resolving to array of model names
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* const models = await client.models.list();
|
|
21
|
+
* console.log(models.data); // ['Transaction', 'Supplier', 'Item', ...]
|
|
22
|
+
*/
|
|
23
|
+
list(): Promise<{
|
|
24
|
+
success: boolean;
|
|
25
|
+
data?: string[];
|
|
26
|
+
error?: string;
|
|
27
|
+
}>;
|
|
28
|
+
/**
|
|
29
|
+
* Get metadata for a model (display names, icons, etc.).
|
|
30
|
+
*
|
|
31
|
+
* @param model - The model name
|
|
32
|
+
* @returns Promise resolving to model metadata
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* const meta = await client.models.getMetadata('Transaction');
|
|
36
|
+
* console.log(meta.data?.display_name); // 'Transaction'
|
|
37
|
+
*/
|
|
38
|
+
getMetadata(model: string): Promise<{
|
|
39
|
+
success: boolean;
|
|
40
|
+
data?: ModelMetadata;
|
|
41
|
+
error?: string;
|
|
42
|
+
}>;
|
|
43
|
+
/**
|
|
44
|
+
* Get the schema for a model (field definitions and types).
|
|
45
|
+
*
|
|
46
|
+
* @param model - The model name
|
|
47
|
+
* @returns Promise resolving to model schema
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* const schema = await client.models.getSchema('Transaction');
|
|
51
|
+
* for (const [field, def] of Object.entries(schema.data?.fields ?? {})) {
|
|
52
|
+
* console.log(`${field}: ${def.type}`);
|
|
53
|
+
* }
|
|
54
|
+
*/
|
|
55
|
+
getSchema(model: string): Promise<{
|
|
56
|
+
success: boolean;
|
|
57
|
+
data?: ModelSchema;
|
|
58
|
+
error?: string;
|
|
59
|
+
}>;
|
|
60
|
+
/**
|
|
61
|
+
* Get relationships for a model (foreign keys, many-to-many, etc.).
|
|
62
|
+
*
|
|
63
|
+
* @param model - The model name
|
|
64
|
+
* @returns Promise resolving to model relations
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* const relations = await client.models.getRelations('Transaction');
|
|
68
|
+
* console.log(relations.data);
|
|
69
|
+
*/
|
|
70
|
+
getRelations(model: string): Promise<{
|
|
71
|
+
success: boolean;
|
|
72
|
+
data?: Record<string, unknown>;
|
|
73
|
+
error?: string;
|
|
74
|
+
}>;
|
|
75
|
+
/**
|
|
76
|
+
* Get metadata for a specific field on a model.
|
|
77
|
+
*
|
|
78
|
+
* @param model - The model name
|
|
79
|
+
* @param field - The field name
|
|
80
|
+
* @returns Promise resolving to field metadata
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* const fieldMeta = await client.models.getFieldMetadata('Transaction', 'supplier');
|
|
84
|
+
*/
|
|
85
|
+
getFieldMetadata(model: string, field: string): Promise<{
|
|
86
|
+
success: boolean;
|
|
87
|
+
data?: Record<string, unknown>;
|
|
88
|
+
error?: string;
|
|
89
|
+
}>;
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=models.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/modules/models.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE3D;;GAEG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;;;;OAQG;IACG,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAW5E;;;;;;;;;OASG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,aAAa,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWrG;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,WAAW,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWjG;;;;;;;;;OASG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWhH;;;;;;;;;OASG;IACG,gBAAgB,CACpB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAUjF"}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Org Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for organisation-level admin operations.
|
|
5
|
+
* Requires organisation admin privileges.
|
|
6
|
+
*/
|
|
7
|
+
import type { HttpClient } from '../http/client';
|
|
8
|
+
import type { OrgTeam, ListOrgTeamsOptions, UpdateOrgTeamRequest, OrgUser, TeamUserAssignment, ListOrgUsersOptions, CreateOrgUserRequest, UpdateOrgUserRequest, AssignUserToTeamRequest, OrgUserGroup, ListOrgUserGroupsOptions } from '../types';
|
|
9
|
+
/**
|
|
10
|
+
* Organisation-level admin operations.
|
|
11
|
+
*
|
|
12
|
+
* **Requires organisation admin privileges.**
|
|
13
|
+
*/
|
|
14
|
+
export declare class OrgModule {
|
|
15
|
+
private readonly http;
|
|
16
|
+
constructor(http: HttpClient);
|
|
17
|
+
/**
|
|
18
|
+
* List all teams in the organisation.
|
|
19
|
+
*/
|
|
20
|
+
listTeams(options?: ListOrgTeamsOptions): Promise<{
|
|
21
|
+
success: boolean;
|
|
22
|
+
data?: {
|
|
23
|
+
items: OrgTeam[];
|
|
24
|
+
metadata: {
|
|
25
|
+
total: number;
|
|
26
|
+
returned: number;
|
|
27
|
+
offset: number;
|
|
28
|
+
limit: number;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
error?: string;
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Get a single team by UUID.
|
|
35
|
+
*/
|
|
36
|
+
getTeam(teamUuid: string): Promise<{
|
|
37
|
+
success: boolean;
|
|
38
|
+
data?: OrgTeam;
|
|
39
|
+
error?: string;
|
|
40
|
+
}>;
|
|
41
|
+
/**
|
|
42
|
+
* Update a team.
|
|
43
|
+
*/
|
|
44
|
+
updateTeam(teamUuid: string, updates: UpdateOrgTeamRequest): Promise<{
|
|
45
|
+
success: boolean;
|
|
46
|
+
data?: OrgTeam;
|
|
47
|
+
error?: string;
|
|
48
|
+
}>;
|
|
49
|
+
/**
|
|
50
|
+
* List all users in the organisation.
|
|
51
|
+
*/
|
|
52
|
+
listUsers(options?: ListOrgUsersOptions): Promise<{
|
|
53
|
+
success: boolean;
|
|
54
|
+
data?: {
|
|
55
|
+
items: OrgUser[];
|
|
56
|
+
metadata: {
|
|
57
|
+
total: number;
|
|
58
|
+
returned: number;
|
|
59
|
+
offset: number;
|
|
60
|
+
limit: number;
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
error?: string;
|
|
64
|
+
}>;
|
|
65
|
+
/**
|
|
66
|
+
* Get a single user by UUID.
|
|
67
|
+
*/
|
|
68
|
+
getUser(userUuid: string): Promise<{
|
|
69
|
+
success: boolean;
|
|
70
|
+
data?: OrgUser;
|
|
71
|
+
error?: string;
|
|
72
|
+
}>;
|
|
73
|
+
/**
|
|
74
|
+
* Get all team assignments for a user.
|
|
75
|
+
*/
|
|
76
|
+
getUserTeamAssignments(userUuid: string): Promise<{
|
|
77
|
+
success: boolean;
|
|
78
|
+
data?: TeamUserAssignment[];
|
|
79
|
+
error?: string;
|
|
80
|
+
}>;
|
|
81
|
+
/**
|
|
82
|
+
* Create a new user in the organisation.
|
|
83
|
+
*/
|
|
84
|
+
createUser(request: CreateOrgUserRequest): Promise<{
|
|
85
|
+
success: boolean;
|
|
86
|
+
data?: OrgUser;
|
|
87
|
+
error?: string;
|
|
88
|
+
}>;
|
|
89
|
+
/**
|
|
90
|
+
* Update user profile (name only - email is read-only).
|
|
91
|
+
*/
|
|
92
|
+
updateUser(userUuid: string, updates: UpdateOrgUserRequest): Promise<{
|
|
93
|
+
success: boolean;
|
|
94
|
+
data?: OrgUser;
|
|
95
|
+
error?: string;
|
|
96
|
+
}>;
|
|
97
|
+
/**
|
|
98
|
+
* Assign a user to a team with groups and settings.
|
|
99
|
+
*/
|
|
100
|
+
assignUserToTeam(request: AssignUserToTeamRequest): Promise<{
|
|
101
|
+
success: boolean;
|
|
102
|
+
data?: TeamUserAssignment;
|
|
103
|
+
error?: string;
|
|
104
|
+
}>;
|
|
105
|
+
/**
|
|
106
|
+
* List all user groups in the organisation.
|
|
107
|
+
*/
|
|
108
|
+
listUserGroups(options?: ListOrgUserGroupsOptions): Promise<{
|
|
109
|
+
success: boolean;
|
|
110
|
+
data?: {
|
|
111
|
+
items: OrgUserGroup[];
|
|
112
|
+
metadata: {
|
|
113
|
+
total: number;
|
|
114
|
+
returned: number;
|
|
115
|
+
offset: number;
|
|
116
|
+
limit: number;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
error?: string;
|
|
120
|
+
}>;
|
|
121
|
+
}
|
|
122
|
+
//# sourceMappingURL=org.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"org.d.ts","sourceRoot":"","sources":["../../../src/modules/org.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,OAAO,EACP,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,YAAY,EACZ,wBAAwB,EACzB,MAAM,UAAU,CAAC;AAElB;;;;GAIG;AACH,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAM7C;;OAEG;IACG,SAAS,CACb,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAAC,QAAQ,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;QAC1G,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAC;IAsCF;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBhE;;OAEG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAkChE;;OAEG;IACG,SAAS,CACb,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAAC,QAAQ,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;QAC1G,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAC;IA0CF;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAoBhE;;OAEG;IACG,sBAAsB,CAC1B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAwB7E;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAqDhE;;OAEG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA8BhE;;OAEG;IACG,gBAAgB,CACpB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAkE3E;;OAEG;IACG,cAAc,CAClB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE;YAAE,KAAK,EAAE,YAAY,EAAE,CAAC;YAAC,QAAQ,EAAE;gBAAE,KAAK,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC;QAC/G,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAC;CA6CH"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Quick Actions Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for managing quick actions (buttons that trigger sentences).
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { QuickActionPayload, ZudelloQuickAction, QuickActionTriggerResponse } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Quick action operations for Zudello.
|
|
10
|
+
*/
|
|
11
|
+
export declare class QuickActionsModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* List all quick actions.
|
|
16
|
+
*/
|
|
17
|
+
list(): Promise<{
|
|
18
|
+
success: boolean;
|
|
19
|
+
data?: ZudelloQuickAction[];
|
|
20
|
+
error?: string;
|
|
21
|
+
}>;
|
|
22
|
+
/**
|
|
23
|
+
* Get a single quick action by UUID.
|
|
24
|
+
*/
|
|
25
|
+
get(actionUuid: string): Promise<{
|
|
26
|
+
success: boolean;
|
|
27
|
+
data?: ZudelloQuickAction;
|
|
28
|
+
error?: string;
|
|
29
|
+
}>;
|
|
30
|
+
/**
|
|
31
|
+
* Create a quick action.
|
|
32
|
+
*/
|
|
33
|
+
create(payload: QuickActionPayload): Promise<{
|
|
34
|
+
success: boolean;
|
|
35
|
+
data?: ZudelloQuickAction;
|
|
36
|
+
error?: string;
|
|
37
|
+
}>;
|
|
38
|
+
/**
|
|
39
|
+
* Update a quick action.
|
|
40
|
+
*/
|
|
41
|
+
update(actionUuid: string, payload: QuickActionPayload): Promise<{
|
|
42
|
+
success: boolean;
|
|
43
|
+
data?: ZudelloQuickAction;
|
|
44
|
+
error?: string;
|
|
45
|
+
}>;
|
|
46
|
+
/**
|
|
47
|
+
* Trigger a quick action on documents.
|
|
48
|
+
*
|
|
49
|
+
* @param actionKey - The quick action key (not UUID)
|
|
50
|
+
* @param documentUuids - Array of document UUIDs to trigger on
|
|
51
|
+
*/
|
|
52
|
+
trigger(actionKey: string, documentUuids: string[]): Promise<{
|
|
53
|
+
success: boolean;
|
|
54
|
+
data?: QuickActionTriggerResponse;
|
|
55
|
+
error?: string;
|
|
56
|
+
}>;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=quick-actions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"quick-actions.d.ts","sourceRoot":"","sources":["../../../src/modules/quick-actions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,kBAAkB;IACjB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAexF;;OAEG;IACG,GAAG,CACP,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAS3E;;OAEG;IACG,MAAM,CACV,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAc3E;;OAEG;IACG,MAAM,CACV,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAc3E;;;;;OAKG;IACG,OAAO,CACX,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,0BAA0B,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CASpF"}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resources Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for creating, updating, and managing Zudello resources.
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { CreateOptions, UpdateOptions, MutationResult, ResourceFetchRequest, BatchFetchOptions, UpdateOrCreateRequest, BatchUpdateOrCreateOptions, UpdateOrCreateResult, AuditEvent } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Resource mutation operations for Zudello.
|
|
10
|
+
*/
|
|
11
|
+
export declare class ResourcesModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* Create a new resource.
|
|
16
|
+
*
|
|
17
|
+
* @param model - The model name (e.g., 'Transaction', 'Supplier')
|
|
18
|
+
* @param options - Creation options including data
|
|
19
|
+
* @returns Promise resolving to the created resource
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* const supplier = await client.resources.create('Supplier', {
|
|
23
|
+
* data: {
|
|
24
|
+
* trading_name: 'ACME Corp',
|
|
25
|
+
* code: 'SUP-001',
|
|
26
|
+
* external_id: 'ERP-SUP-001'
|
|
27
|
+
* }
|
|
28
|
+
* });
|
|
29
|
+
*/
|
|
30
|
+
create<T = Record<string, unknown>>(model: string, options: CreateOptions): Promise<MutationResult<T>>;
|
|
31
|
+
/**
|
|
32
|
+
* Update an existing resource.
|
|
33
|
+
*
|
|
34
|
+
* @param model - The model name (e.g., 'Transaction', 'Supplier')
|
|
35
|
+
* @param identifier - Either { uuid: string } or { externalId: string }
|
|
36
|
+
* @param options - Update options including data
|
|
37
|
+
* @returns Promise resolving to the updated resource
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* const updated = await client.resources.update(
|
|
41
|
+
* 'Supplier',
|
|
42
|
+
* { uuid: 'supplier-uuid' },
|
|
43
|
+
* { data: { trading_name: 'ACME Corporation' } }
|
|
44
|
+
* );
|
|
45
|
+
*/
|
|
46
|
+
update<T = Record<string, unknown>>(model: string, identifier: {
|
|
47
|
+
uuid: string;
|
|
48
|
+
} | {
|
|
49
|
+
externalId: string;
|
|
50
|
+
}, options: UpdateOptions): Promise<MutationResult<T>>;
|
|
51
|
+
/**
|
|
52
|
+
* Fetch multiple resources in a single batch request.
|
|
53
|
+
*
|
|
54
|
+
* @param requests - Array of resource fetch requests
|
|
55
|
+
* @param options - Optional batch options
|
|
56
|
+
* @returns Promise resolving to batch fetch results
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* const results = await client.resources.getMany([
|
|
60
|
+
* { model: 'Supplier', uuid: 'sup-uuid-1' },
|
|
61
|
+
* { model: 'Supplier', uuid: 'sup-uuid-2' },
|
|
62
|
+
* { model: 'Item', external_id: 'ITEM-001' }
|
|
63
|
+
* ]);
|
|
64
|
+
*/
|
|
65
|
+
getMany(requests: ResourceFetchRequest[], options?: BatchFetchOptions): Promise<{
|
|
66
|
+
success: boolean;
|
|
67
|
+
results: Array<{
|
|
68
|
+
success?: boolean;
|
|
69
|
+
model?: string;
|
|
70
|
+
data?: Record<string, unknown>;
|
|
71
|
+
message?: string;
|
|
72
|
+
}>;
|
|
73
|
+
}>;
|
|
74
|
+
/**
|
|
75
|
+
* Update or create multiple resources in a single batch request.
|
|
76
|
+
*
|
|
77
|
+
* @param requests - Array of update/create requests
|
|
78
|
+
* @param options - Optional batch options
|
|
79
|
+
* @returns Promise resolving to batch operation results
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* const results = await client.resources.upsertMany([
|
|
83
|
+
* { model: 'Supplier', data: { external_id: 'SUP-001', trading_name: 'ACME' } },
|
|
84
|
+
* { model: 'Supplier', data: { external_id: 'SUP-002', trading_name: 'Widget Co' } }
|
|
85
|
+
* ]);
|
|
86
|
+
*/
|
|
87
|
+
upsertMany(requests: UpdateOrCreateRequest[], options?: BatchUpdateOrCreateOptions): Promise<{
|
|
88
|
+
success: boolean;
|
|
89
|
+
results: UpdateOrCreateResult[];
|
|
90
|
+
taskId?: string;
|
|
91
|
+
}>;
|
|
92
|
+
/**
|
|
93
|
+
* Get audit history for a resource.
|
|
94
|
+
*
|
|
95
|
+
* @param model - The model name (e.g., 'Transaction')
|
|
96
|
+
* @param uuid - The resource UUID
|
|
97
|
+
* @returns Promise resolving to array of audit events
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* const history = await client.resources.getHistory('Transaction', 'invoice-uuid');
|
|
101
|
+
* for (const event of history.data ?? []) {
|
|
102
|
+
* console.log(`${event.event_type} at ${event.timestamp} by ${event.user?.name}`);
|
|
103
|
+
* }
|
|
104
|
+
*/
|
|
105
|
+
getHistory(model: string, uuid: string): Promise<{
|
|
106
|
+
success: boolean;
|
|
107
|
+
data?: AuditEvent[];
|
|
108
|
+
error?: string;
|
|
109
|
+
}>;
|
|
110
|
+
}
|
|
111
|
+
//# sourceMappingURL=resources.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../../src/modules/resources.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,oBAAoB,EACpB,UAAU,EACX,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IA6C7B;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,EACrD,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAoD7B;;;;;;;;;;;;;OAaG;IACG,OAAO,CACX,QAAQ,EAAE,oBAAoB,EAAE,EAChC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,KAAK,CAAC;YAAE,OAAO,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IAiCzI;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,QAAQ,EAAE,qBAAqB,EAAE,EACjC,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,oBAAoB,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAgDlF;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAQtE"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Search Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for searching, listing, and fetching Zudello resources.
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { SearchOptions, ListOptions, SearchResult, FetchOptions, FetchResult } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Search and retrieval operations for Zudello resources.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SearchModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* Search for resources matching the given criteria.
|
|
16
|
+
*
|
|
17
|
+
* @param options - Search options including model, filters, and pagination
|
|
18
|
+
* @returns Promise resolving to search results
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // Find all pending invoices over $1000
|
|
22
|
+
* const invoices = await client.search.query({
|
|
23
|
+
* model: 'Transaction',
|
|
24
|
+
* module: 'PURCHASING',
|
|
25
|
+
* submodule: 'INVOICE',
|
|
26
|
+
* filter: { status__in: ['REVIEW', 'APPROVAL'], total__gt: 1000 },
|
|
27
|
+
* select: ['uuid', 'document_number', 'total', 'date_due'],
|
|
28
|
+
* order_by: ['-total']
|
|
29
|
+
* });
|
|
30
|
+
*/
|
|
31
|
+
query<T = Record<string, unknown>>(options: SearchOptions): Promise<SearchResult<T>>;
|
|
32
|
+
/**
|
|
33
|
+
* Iterate over all resources matching the given criteria using async iteration.
|
|
34
|
+
* Automatically handles pagination.
|
|
35
|
+
*
|
|
36
|
+
* @param options - List options including model, filters, and page size
|
|
37
|
+
* @yields Each resource matching the criteria
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* // Process all invoices
|
|
41
|
+
* for await (const invoice of client.search.list({ model: 'Transaction', module: 'PURCHASING' })) {
|
|
42
|
+
* console.log(invoice.document_number);
|
|
43
|
+
* }
|
|
44
|
+
*/
|
|
45
|
+
list<T = Record<string, unknown>>(options: ListOptions): AsyncGenerator<T, void, unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* Fetch a single resource by UUID or external ID.
|
|
48
|
+
*
|
|
49
|
+
* @param model - The model name (e.g., 'Transaction', 'Supplier')
|
|
50
|
+
* @param identifier - Either { uuid: string } or { externalId: string }
|
|
51
|
+
* @param options - Additional fetch options
|
|
52
|
+
* @returns Promise resolving to the fetched resource
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* // Fetch by UUID
|
|
56
|
+
* const invoice = await client.search.fetch('Transaction', { uuid: 'invoice-uuid' });
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* // Fetch by external ID with related data
|
|
60
|
+
* const supplier = await client.search.fetch(
|
|
61
|
+
* 'Supplier',
|
|
62
|
+
* { externalId: 'SUP-001' },
|
|
63
|
+
* { includeModels: 'BankAccount,Contact' }
|
|
64
|
+
* );
|
|
65
|
+
*/
|
|
66
|
+
fetch<T = Record<string, unknown>>(model: string, identifier: {
|
|
67
|
+
uuid: string;
|
|
68
|
+
} | {
|
|
69
|
+
externalId: string;
|
|
70
|
+
}, options?: FetchOptions): Promise<FetchResult<T>>;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=search.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/modules/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,EACZ,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;;;;;;;;;;;;OAgBG;IACG,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAmE1F;;;;;;;;;;;;OAYG;IACI,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC;IA8BhG;;;;;;;;;;;;;;;;;;;OAmBG;IACG,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,EACrD,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAwD3B"}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sentences Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for managing Zudello sentences (automation/business rules).
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { ZudelloSentence, ListSentencesOptions, SentenceResource, CreateSentencePayload } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Sentence (automation rule) operations for Zudello.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SentencesModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* Get a specific sentence by UUID.
|
|
16
|
+
*/
|
|
17
|
+
get(uuid: string, returnDeleted?: boolean): Promise<{
|
|
18
|
+
success: boolean;
|
|
19
|
+
data?: ZudelloSentence;
|
|
20
|
+
error?: string;
|
|
21
|
+
}>;
|
|
22
|
+
/**
|
|
23
|
+
* Get a specific sentence template by UUID.
|
|
24
|
+
*/
|
|
25
|
+
getTemplate(uuid: string, returnDeleted?: boolean): Promise<{
|
|
26
|
+
success: boolean;
|
|
27
|
+
data?: ZudelloSentence;
|
|
28
|
+
error?: string;
|
|
29
|
+
}>;
|
|
30
|
+
/**
|
|
31
|
+
* List sentences for a module.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* const sentences = await client.sentences.list('PURCHASING', {
|
|
35
|
+
* submodule: 'INVOICE',
|
|
36
|
+
* enabled: true
|
|
37
|
+
* });
|
|
38
|
+
*/
|
|
39
|
+
list(module: string, options?: ListSentencesOptions): Promise<{
|
|
40
|
+
success: boolean;
|
|
41
|
+
data?: ZudelloSentence[];
|
|
42
|
+
error?: string;
|
|
43
|
+
}>;
|
|
44
|
+
/**
|
|
45
|
+
* List sentence templates for a module.
|
|
46
|
+
*/
|
|
47
|
+
listTemplates(module: string, submodule?: string): Promise<{
|
|
48
|
+
success: boolean;
|
|
49
|
+
data?: ZudelloSentence[];
|
|
50
|
+
error?: string;
|
|
51
|
+
}>;
|
|
52
|
+
/**
|
|
53
|
+
* List sentence resources (action or condition templates).
|
|
54
|
+
*
|
|
55
|
+
* @param resourceType - Either 'ACTION_TEMPLATE' or 'CONDITION_TEMPLATE'
|
|
56
|
+
* @param module - The module context
|
|
57
|
+
*/
|
|
58
|
+
listResources(resourceType: 'ACTION_TEMPLATE' | 'CONDITION_TEMPLATE', module: string): Promise<{
|
|
59
|
+
success: boolean;
|
|
60
|
+
data?: SentenceResource[];
|
|
61
|
+
error?: string;
|
|
62
|
+
}>;
|
|
63
|
+
/**
|
|
64
|
+
* Create a new sentence.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* const sentence = await client.sentences.create('PURCHASING', {
|
|
68
|
+
* categories: ['Workflow'],
|
|
69
|
+
* evalOrder: 10,
|
|
70
|
+
* enabled: true,
|
|
71
|
+
* recipe: {
|
|
72
|
+
* name: 'Auto-approve small invoices',
|
|
73
|
+
* event_type: ['TRANSACTION_CREATED'],
|
|
74
|
+
* blocks: [{
|
|
75
|
+
* conditions: [{ type: 'CUSTOM_CONDITION', field: { value: 'total' }, operator: { value: '<' }, value: 100 }],
|
|
76
|
+
* actions: [{ type: 'SET_STATUS', params: { status: 'APPROVED' } }]
|
|
77
|
+
* }]
|
|
78
|
+
* }
|
|
79
|
+
* });
|
|
80
|
+
*/
|
|
81
|
+
create(module: string, payload: CreateSentencePayload, user?: string, sendToLpm?: boolean): Promise<{
|
|
82
|
+
success: boolean;
|
|
83
|
+
data?: ZudelloSentence;
|
|
84
|
+
error?: string;
|
|
85
|
+
}>;
|
|
86
|
+
/**
|
|
87
|
+
* Update an existing sentence.
|
|
88
|
+
*/
|
|
89
|
+
update(uuid: string, module: string, payload: Partial<CreateSentencePayload>, user?: string, sendToLpm?: boolean): Promise<{
|
|
90
|
+
success: boolean;
|
|
91
|
+
data?: ZudelloSentence;
|
|
92
|
+
error?: string;
|
|
93
|
+
}>;
|
|
94
|
+
/**
|
|
95
|
+
* Update the order of sentences.
|
|
96
|
+
*/
|
|
97
|
+
updateOrder(module: string, sentenceOrders: Array<{
|
|
98
|
+
uuid: string;
|
|
99
|
+
evalOrder: number;
|
|
100
|
+
}>): Promise<{
|
|
101
|
+
success: boolean;
|
|
102
|
+
error?: string;
|
|
103
|
+
}>;
|
|
104
|
+
}
|
|
105
|
+
//# sourceMappingURL=sentences.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sentences.d.ts","sourceRoot":"","sources":["../../../src/modules/sentences.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;OAEG;IACG,GAAG,CACP,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,GACpB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAYxE;;OAEG;IACG,WAAW,CACf,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,GACpB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAYxE;;;;;;;;OAQG;IACG,IAAI,CACR,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB1E;;OAEG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAe1E;;;;;OAKG;IACG,aAAa,CACjB,YAAY,EAAE,iBAAiB,GAAG,oBAAoB,EACtD,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAa3E;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,qBAAqB,EAC9B,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,UAAO,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBxE;;OAEG;IACG,MAAM,CACV,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,UAAO,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBxE;;OAEG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,GACzD,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CASjD"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Users Module
|
|
3
|
+
*
|
|
4
|
+
* Methods for managing team users, notifications, and language settings.
|
|
5
|
+
*/
|
|
6
|
+
import type { HttpClient } from '../http/client';
|
|
7
|
+
import type { TeamUser, GetUsersOptions, NotificationType, NotificationPreference, LanguagePlaceholderEntry } from '../types';
|
|
8
|
+
/**
|
|
9
|
+
* Team user operations for Zudello.
|
|
10
|
+
*/
|
|
11
|
+
export declare class UsersModule {
|
|
12
|
+
private readonly http;
|
|
13
|
+
constructor(http: HttpClient);
|
|
14
|
+
/**
|
|
15
|
+
* Get users for the team.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* const users = await client.users.list({ status: 'ACTIVE' });
|
|
19
|
+
*/
|
|
20
|
+
list(options?: GetUsersOptions): Promise<{
|
|
21
|
+
success: boolean;
|
|
22
|
+
data?: TeamUser[];
|
|
23
|
+
error?: string;
|
|
24
|
+
}>;
|
|
25
|
+
/**
|
|
26
|
+
* Get available notification types.
|
|
27
|
+
*/
|
|
28
|
+
getNotificationTypes(): Promise<{
|
|
29
|
+
success: boolean;
|
|
30
|
+
data?: NotificationType[];
|
|
31
|
+
error?: string;
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Get notification preferences for a user.
|
|
35
|
+
*/
|
|
36
|
+
getNotificationPreferences(userUuid: string): Promise<{
|
|
37
|
+
success: boolean;
|
|
38
|
+
data?: NotificationPreference[];
|
|
39
|
+
error?: string;
|
|
40
|
+
}>;
|
|
41
|
+
/**
|
|
42
|
+
* Update notification preferences.
|
|
43
|
+
*/
|
|
44
|
+
updateNotificationPreferences(preferences: NotificationPreference[]): Promise<{
|
|
45
|
+
success: boolean;
|
|
46
|
+
data?: NotificationPreference[];
|
|
47
|
+
error?: string;
|
|
48
|
+
}>;
|
|
49
|
+
/**
|
|
50
|
+
* Get language placeholders.
|
|
51
|
+
*/
|
|
52
|
+
getLanguagePlaceholders(): Promise<{
|
|
53
|
+
success: boolean;
|
|
54
|
+
data?: Record<string, LanguagePlaceholderEntry>;
|
|
55
|
+
error?: string;
|
|
56
|
+
}>;
|
|
57
|
+
/**
|
|
58
|
+
* Update language placeholders.
|
|
59
|
+
*/
|
|
60
|
+
updateLanguagePlaceholders(placeholders: Record<string, LanguagePlaceholderEntry>): Promise<{
|
|
61
|
+
success: boolean;
|
|
62
|
+
error?: string;
|
|
63
|
+
}>;
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=users.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/modules/users.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EAEzB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;OAKG;IACG,IAAI,CACR,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAmBnE;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWtG;;OAEG;IACG,0BAA0B,CAC9B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,sBAAsB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWjF;;OAEG;IACG,6BAA6B,CACjC,WAAW,EAAE,sBAAsB,EAAE,GACpC,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,sBAAsB,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAYjF;;OAEG;IACG,uBAAuB,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAkB/H;;OAEG;IACG,0BAA0B,CAC9B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,GACrD,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAwCjD"}
|