@uidu/client 3.19.0 → 3.20.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @uidu/client
2
2
 
3
+ ## 3.20.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 5d944da: Write contracts: `createContract`, `updateContract`, `activateContract`, `discardContract`, `createContractItem`, `updateContractItem`, `deleteContractItem`. Contract reads now carry their lines (`contractItems`) and the sector of their analytic account (`analyticAccount.effectiveResponsibleCircle`), which `listAnalyticAccounts` returns too. The custom-app template says contracts are reachable from an app.
8
+
3
9
  ## 3.19.0
4
10
 
5
11
  ### Minor Changes
@@ -1,8 +1,503 @@
1
1
  import type { UiduClient } from "./client.js";
2
- import { type GetContractQuery, type GetContractQueryVariables, type ListContractsQuery, type ListContractsQueryVariables } from "./generated/index.js";
2
+ import { type ActivateContractMutationVariables, type CreateContractItemMutationVariables, type CreateContractMutationVariables, type DeleteContractItemMutationVariables, type DiscardContractMutationVariables, type UpdateContractItemMutationVariables, type UpdateContractMutationVariables, type GetContractQuery, type GetContractQueryVariables, type ListContractsQuery, type ListContractsQueryVariables } from "./generated/index.js";
3
3
  export type Contract = NonNullable<NonNullable<NonNullable<NonNullable<ListContractsQuery['currentWorkspace']>['contracts']['edges']>[number]>['node']>;
4
4
  export type ContractDetail = NonNullable<NonNullable<GetContractQuery['currentWorkspace']>['contract']>;
5
5
  /** The workspace's contracts with their custom fields, filtered with `params`; page with `first`/`after`. */
6
6
  export declare function listContracts(client: UiduClient, variables?: ListContractsQueryVariables): Promise<Contract[]>;
7
7
  /** One contract with its field values and the fields that apply to it, or null. */
8
8
  export declare function getContract(client: UiduClient, variables: GetContractQueryVariables): Promise<ContractDetail | null>;
9
+ /**
10
+ * Create a contract: `{ input: { attributes: { workspaceId, name, startsOn,
11
+ * endsOn, counterpartId, analyticAccountId, fieldValues } } }`. `counterpartId`
12
+ * is an Organization or Contact (see `createOrganization` for a new client).
13
+ * The new contract starts as a draft. Returns the payload (with `errors`) or
14
+ * null; the contract is at `contract.node`.
15
+ */
16
+ export declare function createContract(client: UiduClient, variables: CreateContractMutationVariables): Promise<{
17
+ __typename?: "CreateContractPayload";
18
+ contract?: {
19
+ __typename?: "ContractEdge";
20
+ node?: {
21
+ __typename?: "Contract";
22
+ fieldValuesByShortname?: any | null;
23
+ id: string;
24
+ name: string;
25
+ reference?: string | null;
26
+ aasmState: string;
27
+ direction: import("./generated/index.js").ContractDirectionEnum;
28
+ renewal: import("./generated/index.js").ContractRenewalEnum;
29
+ currency: string;
30
+ recurringAmount: number;
31
+ startsOn: any;
32
+ endsOn?: any | null;
33
+ noticePeriodDays?: number | null;
34
+ body?: any | null;
35
+ createdAt: any;
36
+ updatedAt: any;
37
+ analyticAccount?: {
38
+ __typename?: "AnalyticAccount";
39
+ id: string;
40
+ name: string;
41
+ code: string;
42
+ effectiveResponsibleCircle?: {
43
+ __typename?: "Circle";
44
+ id: string;
45
+ name?: string | null;
46
+ } | null;
47
+ } | null;
48
+ contractItems: {
49
+ __typename?: "ContractItemConnection";
50
+ edges?: Array<{
51
+ __typename?: "ContractItemEdge";
52
+ node?: {
53
+ __typename?: "ContractItem";
54
+ id: string;
55
+ description?: string | null;
56
+ quantity: number;
57
+ unitAmount: number;
58
+ startsAt?: any | null;
59
+ endsAt?: any | null;
60
+ } | null;
61
+ } | null> | null;
62
+ };
63
+ counterpart?: {
64
+ __typename: "Contact";
65
+ id: string;
66
+ name?: string | null;
67
+ } | {
68
+ __typename: "Organization";
69
+ id: string;
70
+ name?: string | null;
71
+ } | null;
72
+ } | null;
73
+ } | null;
74
+ errors: Array<{
75
+ __typename?: "Error";
76
+ key: string;
77
+ name: string;
78
+ type: string;
79
+ }>;
80
+ } | null>;
81
+ /**
82
+ * Update a contract's terms, client, analytic account or custom `fieldValues`:
83
+ * `{ input: { id, attributes } }`. Returns the payload (with `errors`) or null.
84
+ */
85
+ export declare function updateContract(client: UiduClient, variables: UpdateContractMutationVariables): Promise<{
86
+ __typename?: "UpdateContractPayload";
87
+ contract?: {
88
+ __typename?: "Contract";
89
+ fieldValuesByShortname?: any | null;
90
+ id: string;
91
+ name: string;
92
+ reference?: string | null;
93
+ aasmState: string;
94
+ direction: import("./generated/index.js").ContractDirectionEnum;
95
+ renewal: import("./generated/index.js").ContractRenewalEnum;
96
+ currency: string;
97
+ recurringAmount: number;
98
+ startsOn: any;
99
+ endsOn?: any | null;
100
+ noticePeriodDays?: number | null;
101
+ body?: any | null;
102
+ createdAt: any;
103
+ updatedAt: any;
104
+ analyticAccount?: {
105
+ __typename?: "AnalyticAccount";
106
+ id: string;
107
+ name: string;
108
+ code: string;
109
+ effectiveResponsibleCircle?: {
110
+ __typename?: "Circle";
111
+ id: string;
112
+ name?: string | null;
113
+ } | null;
114
+ } | null;
115
+ contractItems: {
116
+ __typename?: "ContractItemConnection";
117
+ edges?: Array<{
118
+ __typename?: "ContractItemEdge";
119
+ node?: {
120
+ __typename?: "ContractItem";
121
+ id: string;
122
+ description?: string | null;
123
+ quantity: number;
124
+ unitAmount: number;
125
+ startsAt?: any | null;
126
+ endsAt?: any | null;
127
+ } | null;
128
+ } | null> | null;
129
+ };
130
+ counterpart?: {
131
+ __typename: "Contact";
132
+ id: string;
133
+ name?: string | null;
134
+ } | {
135
+ __typename: "Organization";
136
+ id: string;
137
+ name?: string | null;
138
+ } | null;
139
+ } | null;
140
+ errors: Array<{
141
+ __typename?: "Error";
142
+ key: string;
143
+ name: string;
144
+ type: string;
145
+ }>;
146
+ } | null>;
147
+ /** Sign a draft contract (draft → active): `{ input: { id } }`. Returns the payload or null. */
148
+ export declare function activateContract(client: UiduClient, variables: ActivateContractMutationVariables): Promise<{
149
+ __typename?: "ActivateContractPayload";
150
+ contract?: {
151
+ __typename?: "Contract";
152
+ id: string;
153
+ aasmState: string;
154
+ } | null;
155
+ errors: Array<{
156
+ __typename?: "Error";
157
+ key: string;
158
+ name: string;
159
+ type: string;
160
+ }>;
161
+ } | null>;
162
+ /** Move a contract to the trash (restorable for 30 days): `{ input: { id } }`. Returns the payload or null. */
163
+ export declare function discardContract(client: UiduClient, variables: DiscardContractMutationVariables): Promise<{
164
+ __typename?: "DiscardPayload";
165
+ discardable?: {
166
+ __typename?: "Activity";
167
+ } | {
168
+ __typename?: "Adjustment";
169
+ } | {
170
+ __typename?: "AdministrativeCompetence";
171
+ } | {
172
+ __typename?: "Allocation";
173
+ } | {
174
+ __typename?: "AnalyticAccount";
175
+ } | {
176
+ __typename?: "App";
177
+ } | {
178
+ __typename?: "Application";
179
+ } | {
180
+ __typename?: "Approval";
181
+ } | {
182
+ __typename?: "ApprovalForm";
183
+ } | {
184
+ __typename?: "Associate";
185
+ } | {
186
+ __typename?: "Attachment";
187
+ } | {
188
+ __typename?: "Attendance";
189
+ } | {
190
+ __typename?: "AttendanceRule";
191
+ } | {
192
+ __typename?: "BankAccountLink";
193
+ } | {
194
+ __typename?: "BankConsent";
195
+ } | {
196
+ __typename?: "BankTransaction";
197
+ } | {
198
+ __typename?: "Blob";
199
+ } | {
200
+ __typename?: "Budget";
201
+ } | {
202
+ __typename?: "Calendar";
203
+ } | {
204
+ __typename?: "CalendarEvent";
205
+ } | {
206
+ __typename?: "Call";
207
+ } | {
208
+ __typename?: "Campaign";
209
+ } | {
210
+ __typename?: "Carrier";
211
+ } | {
212
+ __typename?: "Ccnl";
213
+ } | {
214
+ __typename?: "CcnlLevel";
215
+ } | {
216
+ __typename?: "Certification";
217
+ } | {
218
+ __typename?: "Channel";
219
+ } | {
220
+ __typename?: "Circle";
221
+ } | {
222
+ __typename?: "Comment";
223
+ } | {
224
+ __typename?: "CommitmentSlot";
225
+ } | {
226
+ __typename?: "Contact";
227
+ } | {
228
+ __typename?: "Contract";
229
+ id: string;
230
+ } | {
231
+ __typename?: "Conversation";
232
+ } | {
233
+ __typename?: "Coupon";
234
+ } | {
235
+ __typename?: "Course";
236
+ } | {
237
+ __typename?: "CourseArea";
238
+ } | {
239
+ __typename?: "CourseEdition";
240
+ } | {
241
+ __typename?: "CoverageRequirement";
242
+ } | {
243
+ __typename?: "CreditLine";
244
+ } | {
245
+ __typename?: "Customer";
246
+ } | {
247
+ __typename?: "DataView";
248
+ } | {
249
+ __typename?: "Deal";
250
+ } | {
251
+ __typename?: "Delivery";
252
+ } | {
253
+ __typename?: "Document";
254
+ } | {
255
+ __typename?: "DocumentModel";
256
+ } | {
257
+ __typename?: "DocumentProject";
258
+ } | {
259
+ __typename?: "DocumentRequest";
260
+ } | {
261
+ __typename?: "DonationCampaign";
262
+ } | {
263
+ __typename?: "Employee";
264
+ } | {
265
+ __typename?: "Employment";
266
+ } | {
267
+ __typename?: "EmploymentKind";
268
+ } | {
269
+ __typename?: "EmploymentVariationKind";
270
+ } | {
271
+ __typename?: "Event";
272
+ } | {
273
+ __typename?: "EventStoreEvent";
274
+ } | {
275
+ __typename?: "Expense";
276
+ } | {
277
+ __typename?: "ExpenseReport";
278
+ } | {
279
+ __typename?: "Experience";
280
+ } | {
281
+ __typename?: "Folder";
282
+ } | {
283
+ __typename?: "Form";
284
+ } | {
285
+ __typename?: "FormPage";
286
+ } | {
287
+ __typename?: "FormQuestion";
288
+ } | {
289
+ __typename?: "FormResponse";
290
+ } | {
291
+ __typename?: "Goal";
292
+ } | {
293
+ __typename?: "IncomingWebhook";
294
+ } | {
295
+ __typename?: "KbArticle";
296
+ } | {
297
+ __typename?: "KbCollection";
298
+ } | {
299
+ __typename?: "Kind";
300
+ } | {
301
+ __typename?: "Kiosk";
302
+ } | {
303
+ __typename?: "LectureModule";
304
+ } | {
305
+ __typename?: "List";
306
+ } | {
307
+ __typename?: "ListSubscription";
308
+ } | {
309
+ __typename?: "ManagementAccount";
310
+ } | {
311
+ __typename?: "Meeting";
312
+ } | {
313
+ __typename?: "Message";
314
+ } | {
315
+ __typename?: "Model";
316
+ } | {
317
+ __typename?: "ModelItem";
318
+ } | {
319
+ __typename?: "Note";
320
+ } | {
321
+ __typename?: "Obligation";
322
+ } | {
323
+ __typename?: "ObligationAssignment";
324
+ } | {
325
+ __typename?: "ObligationKind";
326
+ } | {
327
+ __typename?: "Office";
328
+ } | {
329
+ __typename?: "Order";
330
+ } | {
331
+ __typename?: "Organization";
332
+ } | {
333
+ __typename?: "OrganizationKind";
334
+ } | {
335
+ __typename?: "Payment";
336
+ } | {
337
+ __typename?: "PaymentProfile";
338
+ } | {
339
+ __typename?: "Pipeline";
340
+ } | {
341
+ __typename?: "Pool";
342
+ } | {
343
+ __typename?: "Position";
344
+ } | {
345
+ __typename?: "Project";
346
+ } | {
347
+ __typename?: "Proposal";
348
+ } | {
349
+ __typename?: "Purchase";
350
+ } | {
351
+ __typename?: "PurchaseOrder";
352
+ } | {
353
+ __typename?: "PurchaseRequest";
354
+ } | {
355
+ __typename?: "Receipt";
356
+ } | {
357
+ __typename?: "Reminder";
358
+ } | {
359
+ __typename?: "Review";
360
+ } | {
361
+ __typename?: "ReviewCycle";
362
+ } | {
363
+ __typename?: "ReviewTemplate";
364
+ } | {
365
+ __typename?: "ScheduledMessage";
366
+ } | {
367
+ __typename?: "Service";
368
+ } | {
369
+ __typename?: "Shift";
370
+ } | {
371
+ __typename?: "Site";
372
+ } | {
373
+ __typename?: "Sku";
374
+ } | {
375
+ __typename?: "Space";
376
+ } | {
377
+ __typename?: "Status";
378
+ } | {
379
+ __typename?: "Story";
380
+ } | {
381
+ __typename?: "Supplier";
382
+ } | {
383
+ __typename?: "Task";
384
+ } | {
385
+ __typename?: "TaskUser";
386
+ } | {
387
+ __typename?: "Template";
388
+ } | {
389
+ __typename?: "TemplateBlock";
390
+ } | {
391
+ __typename?: "TimeClock";
392
+ } | {
393
+ __typename?: "TimeEntryKind";
394
+ } | {
395
+ __typename?: "TimeOff";
396
+ } | {
397
+ __typename?: "TimeOffKind";
398
+ } | {
399
+ __typename?: "Tour";
400
+ } | {
401
+ __typename?: "TourStep";
402
+ } | {
403
+ __typename?: "TrainingNeed";
404
+ } | {
405
+ __typename?: "TransactionKind";
406
+ } | {
407
+ __typename?: "Transfer";
408
+ } | {
409
+ __typename?: "TreasuryAccount";
410
+ } | {
411
+ __typename?: "User";
412
+ } | {
413
+ __typename?: "Venue";
414
+ } | {
415
+ __typename?: "VenueBooking";
416
+ } | {
417
+ __typename?: "VenueFloor";
418
+ } | {
419
+ __typename?: "VenueRow";
420
+ } | {
421
+ __typename?: "Warehouse";
422
+ } | {
423
+ __typename?: "WorkOrder";
424
+ } | {
425
+ __typename?: "WorkSite";
426
+ } | {
427
+ __typename?: "Workflow";
428
+ } | {
429
+ __typename?: "WorkspaceAgentAiChat";
430
+ } | {
431
+ __typename?: "WorkspaceAsset";
432
+ } | {
433
+ __typename?: "WorkspaceSkill";
434
+ } | {
435
+ __typename?: "WorkspaceTag";
436
+ } | null;
437
+ errors: Array<{
438
+ __typename?: "Error";
439
+ key: string;
440
+ name: string;
441
+ type: string;
442
+ }>;
443
+ } | null>;
444
+ /**
445
+ * Add an economic line to a contract: `{ input: { attributes: { contractId,
446
+ * description, quantity, unitAmount, startsAt, endsAt } } }`, with
447
+ * `unitAmount` in cents. Returns the payload (with `errors`) or null; the line
448
+ * is at `contractItem.node`.
449
+ */
450
+ export declare function createContractItem(client: UiduClient, variables: CreateContractItemMutationVariables): Promise<{
451
+ __typename?: "CreateContractItemPayload";
452
+ contractItem?: {
453
+ __typename?: "ContractItemEdge";
454
+ node?: {
455
+ __typename?: "ContractItem";
456
+ id: string;
457
+ description?: string | null;
458
+ quantity: number;
459
+ unitAmount: number;
460
+ startsAt?: any | null;
461
+ endsAt?: any | null;
462
+ } | null;
463
+ } | null;
464
+ errors: Array<{
465
+ __typename?: "Error";
466
+ key: string;
467
+ name: string;
468
+ type: string;
469
+ }>;
470
+ } | null>;
471
+ /** Update a contract line: `{ input: { id, attributes } }`. Returns the payload (with `errors`) or null. */
472
+ export declare function updateContractItem(client: UiduClient, variables: UpdateContractItemMutationVariables): Promise<{
473
+ __typename?: "UpdateContractItemPayload";
474
+ contractItem?: {
475
+ __typename?: "ContractItem";
476
+ id: string;
477
+ description?: string | null;
478
+ quantity: number;
479
+ unitAmount: number;
480
+ startsAt?: any | null;
481
+ endsAt?: any | null;
482
+ } | null;
483
+ errors: Array<{
484
+ __typename?: "Error";
485
+ key: string;
486
+ name: string;
487
+ type: string;
488
+ }>;
489
+ } | null>;
490
+ /** Remove a contract line: `{ input: { id } }`. Returns the payload or null. */
491
+ export declare function deleteContractItem(client: UiduClient, variables: DeleteContractItemMutationVariables): Promise<{
492
+ __typename?: "DeleteContractItemPayload";
493
+ contractItem?: {
494
+ __typename?: "ContractItem";
495
+ id: string;
496
+ } | null;
497
+ errors: Array<{
498
+ __typename?: "Error";
499
+ key: string;
500
+ name: string;
501
+ type: string;
502
+ }>;
503
+ } | null>;
@@ -133,6 +133,11 @@ export declare function listAnalyticAccounts(client: UiduClient, variables?: Lis
133
133
  name: string;
134
134
  status: import("./generated/index.js").AnalyticAccountStatusEnum;
135
135
  currency: string;
136
+ effectiveResponsibleCircle?: {
137
+ __typename?: "Circle";
138
+ id: string;
139
+ name?: string | null;
140
+ } | null;
136
141
  }[]>;
137
142
  /**
138
143
  * Book an expense (or part of it) on an analytic account: `{ input: {