@uidu/client 3.13.0 → 3.14.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.
Files changed (68) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/declarations/src/actions.d.ts +10 -0
  3. package/dist/declarations/src/applications.d.ts +3 -2
  4. package/dist/declarations/src/benefit-enrollments.d.ts +5 -0
  5. package/dist/declarations/src/benefits.d.ts +5 -0
  6. package/dist/declarations/src/bookings.d.ts +22 -0
  7. package/dist/declarations/src/calls.d.ts +8 -0
  8. package/dist/declarations/src/campaigns.d.ts +12 -0
  9. package/dist/declarations/src/client.d.ts +13 -1
  10. package/dist/declarations/src/cms.d.ts +32 -0
  11. package/dist/declarations/src/contacts.d.ts +16 -0
  12. package/dist/declarations/src/courses.d.ts +23 -0
  13. package/dist/declarations/src/donations.d.ts +34 -1
  14. package/dist/declarations/src/events.d.ts +19 -0
  15. package/dist/declarations/src/forms.d.ts +19 -0
  16. package/dist/declarations/src/generated/index.d.ts +2612 -234
  17. package/dist/declarations/src/goals.d.ts +4 -0
  18. package/dist/declarations/src/help-center.d.ts +4 -0
  19. package/dist/declarations/src/index.d.ts +3 -3
  20. package/dist/declarations/src/kb.d.ts +15 -0
  21. package/dist/declarations/src/models.d.ts +54 -0
  22. package/dist/declarations/src/mutations.d.ts +159 -1
  23. package/dist/declarations/src/notes.d.ts +4 -0
  24. package/dist/declarations/src/people.d.ts +8 -0
  25. package/dist/declarations/src/search.d.ts +7 -0
  26. package/dist/declarations/src/spaces.d.ts +4 -0
  27. package/dist/declarations/src/stories.d.ts +11 -0
  28. package/dist/declarations/src/system.d.ts +4 -0
  29. package/dist/declarations/src/tasks.d.ts +4 -0
  30. package/dist/declarations/src/types.d.ts +4 -0
  31. package/dist/uidu-client.cjs.dev.js +552 -11
  32. package/dist/uidu-client.cjs.prod.js +552 -11
  33. package/dist/uidu-client.esm.js +551 -12
  34. package/package.json +2 -2
  35. package/src/actions.ts +10 -6
  36. package/src/applications.ts +3 -2
  37. package/src/benefit-enrollments.ts +5 -0
  38. package/src/benefits.ts +5 -0
  39. package/src/bookings.ts +22 -0
  40. package/src/calls.ts +8 -0
  41. package/src/campaigns.ts +12 -0
  42. package/src/client.ts +13 -1
  43. package/src/cms.ts +32 -0
  44. package/src/contacts.ts +16 -0
  45. package/src/courses.ts +23 -0
  46. package/src/donations.test.ts +57 -0
  47. package/src/donations.ts +47 -0
  48. package/src/events.ts +19 -0
  49. package/src/forms.ts +19 -0
  50. package/src/generated/index.ts +2289 -282
  51. package/src/goals.ts +4 -0
  52. package/src/help-center.ts +4 -0
  53. package/src/index.ts +3 -1
  54. package/src/kb.ts +15 -0
  55. package/src/models.ts +54 -0
  56. package/src/mutations.ts +159 -1
  57. package/src/notes.ts +4 -0
  58. package/src/people.ts +8 -0
  59. package/src/queries/cms/GetPage.graphql +1 -0
  60. package/src/queries/donations/GetDonationCampaign.graphql +19 -0
  61. package/src/queries/donations/ListDonationCampaigns.graphql +5 -0
  62. package/src/queries/donations/ListDonations.graphql +29 -0
  63. package/src/search.ts +7 -0
  64. package/src/spaces.ts +4 -0
  65. package/src/stories.ts +11 -0
  66. package/src/system.ts +4 -0
  67. package/src/tasks.ts +4 -0
  68. package/src/types.ts +4 -0
@@ -32,6 +32,10 @@ export declare function listGoals(client: UiduClient, variables?: ListGoalsQuery
32
32
  }[]>;
33
33
  /** One goal with its key results (`subgoals`). */
34
34
  export declare function getGoal(client: UiduClient, variables: GetGoalQueryVariables): Promise<Goal | null>;
35
+ /**
36
+ * The workspace's timeframes (the periods goals run over, `active` marks the
37
+ * current ones) as a flat array; page with `first`/`after`.
38
+ */
35
39
  export declare function listTimeframes(client: UiduClient, variables?: ListTimeframesQueryVariables): Promise<{
36
40
  __typename?: "Timeframe";
37
41
  id: string;
@@ -1,6 +1,10 @@
1
1
  import type { UiduClient } from "./client.js";
2
2
  import { type GetChannelQuery, type GetChannelQueryVariables, type ListChannelsQueryVariables } from "./generated/index.js";
3
3
  export type Channel = NonNullable<NonNullable<GetChannelQuery['currentWorkspace']>['channel']>;
4
+ /**
5
+ * One help center channel with its collections and their articles in a single
6
+ * request (the last 100 of each), or null.
7
+ */
4
8
  export declare function getChannel(client: UiduClient, variables: GetChannelQueryVariables): Promise<Channel | null>;
5
9
  /**
6
10
  * The workspace's help center channels. `isDefault` marks the one the
@@ -4,7 +4,7 @@ export type { UiduClientConfig, UiduErrorOptions } from "./types.js";
4
4
  export { paginate } from "./utils/paginate.js";
5
5
  export type { PaginateOptions } from "./utils/paginate.js";
6
6
  export { normalizeFieldValueContent, normalizeFieldValuesAttributes, } from "./utils/fieldValues.js";
7
- export { ListApplicationsDocument, ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListGoalsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, ListTimeframesDocument, } from "./generated/index.js";
7
+ export { ListApplicationsDocument, ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListDonationsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListGoalsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, ListTimeframesDocument, } from "./generated/index.js";
8
8
  export { getPage, listPages, getTemplate, createProject, createPage, createPageBlock, createFieldValue, listProjects, } from "./cms.js";
9
9
  export type { Page, Template } from "./cms.js";
10
10
  export { getSiteByDomain, getSite, getPageBySlug, listSitePages, getSingletonBlock, createSite, } from "./sites.js";
@@ -31,8 +31,8 @@ export { getJob, listJobs } from "./jobs.js";
31
31
  export type { Job } from "./jobs.js";
32
32
  export { listApplications, createApplication, updateApplication, completeApplication, } from "./applications.js";
33
33
  export type { Application } from "./applications.js";
34
- export { getDonationCampaign, listDonationCampaigns, createDonation, createDonationCampaign, } from "./donations.js";
35
- export type { DonationCampaign } from "./donations.js";
34
+ export { getDonationCampaign, listDonationCampaigns, listDonations, createDonation, createDonationCampaign, } from "./donations.js";
35
+ export type { Donation, DonationCampaign } from "./donations.js";
36
36
  export { getStory, listStories, createStory } from "./stories.js";
37
37
  export type { Story } from "./stories.js";
38
38
  export { listEmployees, getEmployee, weekStartFor, listOffices, listCircles, listRoles, listKinds, listCcnls, createCcnl, listEmploymentHistory, contractEvents, } from "./people.js";
@@ -2,7 +2,15 @@ import type { UiduClient } from "./client.js";
2
2
  import { type GetKbArticleQuery, type GetKbArticleQueryVariables, type GetKbCollectionQuery, type GetKbCollectionQueryVariables, type ListKbArticlesQueryVariables, type ListKbCollectionsQueryVariables } from "./generated/index.js";
3
3
  export type KbArticle = NonNullable<NonNullable<GetKbArticleQuery['currentWorkspace']>['kbArticle']>;
4
4
  export type KbCollection = NonNullable<NonNullable<GetKbCollectionQuery['currentWorkspace']>['kbCollection']>;
5
+ /**
6
+ * One knowledge-base article with its rich-text `body` and its collection, or
7
+ * null.
8
+ */
5
9
  export declare function getKbArticle(client: UiduClient, variables: GetKbArticleQueryVariables): Promise<KbArticle | null>;
10
+ /**
11
+ * Knowledge-base articles across every collection, as a flat array; page with
12
+ * `first`/`after` (or `last`/`before`).
13
+ */
6
14
  export declare function listKbArticles(client: UiduClient, variables?: ListKbArticlesQueryVariables): Promise<{
7
15
  __typename?: "KbArticle";
8
16
  id: string;
@@ -17,7 +25,14 @@ export declare function listKbArticles(client: UiduClient, variables?: ListKbArt
17
25
  name?: any | null;
18
26
  } | null;
19
27
  }[]>;
28
+ /**
29
+ * One knowledge-base collection with its first 50 articles, or null.
30
+ */
20
31
  export declare function getKbCollection(client: UiduClient, variables: GetKbCollectionQueryVariables): Promise<KbCollection | null>;
32
+ /**
33
+ * The workspace's knowledge-base collections as a flat array; page with
34
+ * `first`/`after` (or `last`/`before`).
35
+ */
21
36
  export declare function listKbCollections(client: UiduClient, variables?: ListKbCollectionsQueryVariables): Promise<{
22
37
  __typename?: "KbCollection";
23
38
  id: string;
@@ -23,6 +23,9 @@ export type ModelItem = ModelItemFieldsFragment;
23
23
  export declare function listModels(client: UiduClient, variables: {
24
24
  workspaceAppId: string;
25
25
  }): Promise<Model[]>;
26
+ /**
27
+ * One model with its fields, or null when the id is not a Model.
28
+ */
26
29
  export declare function getModel(client: UiduClient, variables: {
27
30
  id: string;
28
31
  }): Promise<Model | null>;
@@ -34,6 +37,10 @@ export declare function listModelItems(client: UiduClient, variables: {
34
37
  modelId: string;
35
38
  params?: SearchParams;
36
39
  }): Promise<ModelItem[]>;
40
+ /**
41
+ * One model item with its values and its `model.id`, or null when the id is
42
+ * not a ModelItem.
43
+ */
37
44
  export declare function getModelItem(client: UiduClient, variables: {
38
45
  id: string;
39
46
  }): Promise<(ModelItem & {
@@ -41,6 +48,12 @@ export declare function getModelItem(client: UiduClient, variables: {
41
48
  id: string;
42
49
  };
43
50
  }) | null>;
51
+ /**
52
+ * Create a model in a WorkspaceApp (`attributes.modelableId`, `name`,
53
+ * `namePlural`). Returns the payload (with `errors`) or null.
54
+ *
55
+ * To find-or-create a model and its fields in one call, use `ensureModel`.
56
+ */
44
57
  export declare function createModel(client: UiduClient, variables: CreateModelMutationVariables): Promise<{
45
58
  __typename?: "CreateModelPayload";
46
59
  model?: {
@@ -72,6 +85,10 @@ export declare function createModel(client: UiduClient, variables: CreateModelMu
72
85
  type: string;
73
86
  }>;
74
87
  } | null>;
88
+ /**
89
+ * Rename or reconfigure a model: `{ input: { id, attributes } }`. Returns the
90
+ * payload (with `errors`) or null.
91
+ */
75
92
  export declare function updateModel(client: UiduClient, variables: UpdateModelMutationVariables): Promise<{
76
93
  __typename?: "UpdateModelPayload";
77
94
  model?: {
@@ -132,6 +149,10 @@ export declare function createField(client: UiduClient, variables: CreateFieldMu
132
149
  type: string;
133
150
  }>;
134
151
  } | null>;
152
+ /**
153
+ * Update a field (name, `required`, preferences…): `{ input: { id, attributes
154
+ * } }`. Returns the payload (with `errors`) or null.
155
+ */
135
156
  export declare function updateField(client: UiduClient, variables: UpdateFieldMutationVariables): Promise<{
136
157
  __typename?: "UpdateFieldPayload";
137
158
  field?: {
@@ -157,6 +178,10 @@ export declare function updateField(client: UiduClient, variables: UpdateFieldMu
157
178
  type: string;
158
179
  }>;
159
180
  } | null>;
181
+ /**
182
+ * Delete a field from its model by `{ input: { id } }`. Returns the payload
183
+ * (with `errors`) or null.
184
+ */
160
185
  export declare function deleteField(client: UiduClient, variables: DeleteFieldMutationVariables): Promise<{
161
186
  __typename?: "DeleteFieldPayload";
162
187
  field?: {
@@ -170,6 +195,10 @@ export declare function deleteField(client: UiduClient, variables: DeleteFieldMu
170
195
  type: string;
171
196
  }>;
172
197
  } | null>;
198
+ /**
199
+ * Add an option to a select-kind field (`attributes.fieldId`, `name`,
200
+ * `color`). Returns the payload (with `errors`) or null.
201
+ */
173
202
  export declare function createFieldOption(client: UiduClient, variables: CreateFieldOptionMutationVariables): Promise<{
174
203
  __typename?: "CreateFieldOptionPayload";
175
204
  fieldOption?: {
@@ -186,6 +215,10 @@ export declare function createFieldOption(client: UiduClient, variables: CreateF
186
215
  type: string;
187
216
  }>;
188
217
  } | null>;
218
+ /**
219
+ * Update a select option: `{ input: { id, attributes } }`. Returns the payload
220
+ * (with `errors`) or null.
221
+ */
189
222
  export declare function updateFieldOption(client: UiduClient, variables: UpdateFieldOptionMutationVariables): Promise<{
190
223
  __typename?: "UpdateFieldOptionPayload";
191
224
  fieldOption?: {
@@ -202,6 +235,10 @@ export declare function updateFieldOption(client: UiduClient, variables: UpdateF
202
235
  type: string;
203
236
  }>;
204
237
  } | null>;
238
+ /**
239
+ * Delete a select option by `{ input: { id } }`. Returns the payload (with
240
+ * `errors`) or null.
241
+ */
205
242
  export declare function deleteFieldOption(client: UiduClient, variables: DeleteFieldOptionMutationVariables): Promise<{
206
243
  __typename?: "DeleteFieldOptionPayload";
207
244
  fieldOption?: {
@@ -236,6 +273,11 @@ export declare function createModelItem(client: UiduClient, variables: CreateMod
236
273
  type: string;
237
274
  }>;
238
275
  } | null>;
276
+ /**
277
+ * Update an item: `{ input: { id, attributes: { fieldValuesAttributes } } }`,
278
+ * built with `toFieldValuesAttributes`. Returns the payload (with `errors`) or
279
+ * null.
280
+ */
239
281
  export declare function updateModelItem(client: UiduClient, variables: UpdateModelItemMutationVariables): Promise<{
240
282
  __typename?: "UpdateModelItemPayload";
241
283
  modelItem?: {
@@ -253,6 +295,10 @@ export declare function updateModelItem(client: UiduClient, variables: UpdateMod
253
295
  type: string;
254
296
  }>;
255
297
  } | null>;
298
+ /**
299
+ * Delete an item by `{ input: { id } }`. Returns the payload (with `errors`)
300
+ * or null.
301
+ */
256
302
  export declare function deleteModelItem(client: UiduClient, variables: DeleteModelItemMutationVariables): Promise<{
257
303
  __typename?: "DeleteModelItemPayload";
258
304
  modelItem?: {
@@ -266,6 +312,10 @@ export declare function deleteModelItem(client: UiduClient, variables: DeleteMod
266
312
  type: string;
267
313
  }>;
268
314
  } | null>;
315
+ /**
316
+ * Set a single value by its FieldValue id: `{ input: { id, attributes: {
317
+ * content: { value } } } }`. Returns the payload (with `errors`) or null.
318
+ */
269
319
  export declare function updateFieldValue(client: UiduClient, variables: UpdateFieldValueMutationVariables): Promise<{
270
320
  __typename?: "UpdateFieldValuePayload";
271
321
  fieldValue?: {
@@ -280,6 +330,10 @@ export declare function updateFieldValue(client: UiduClient, variables: UpdateFi
280
330
  type: string;
281
331
  }>;
282
332
  } | null>;
333
+ /**
334
+ * Clear a single value by its FieldValue id; `deleteLinkedRecord: true` also
335
+ * deletes the record it links to. Returns the payload (with `errors`) or null.
336
+ */
283
337
  export declare function deleteFieldValue(client: UiduClient, variables: DeleteFieldValueMutationVariables): Promise<{
284
338
  __typename?: "DeleteFieldValuePayload";
285
339
  fieldValue?: {
@@ -1,5 +1,9 @@
1
1
  import type { UiduClient } from "./client.js";
2
2
  import { type CreateChannelMutationVariables, type CreateContactMutationVariables, type CreateCourseMutationVariables, type CreateCompensationMutationVariables, type CreateDealMutationVariables, type CreateEmployeeMutationVariables, type CreateEmploymentMutationVariables, type CreateFormMutationVariables, type CreateKbArticleMutationVariables, type CreateKbCollectionMutationVariables, type CreateTimeClockMutationVariables, type DeleteChannelMutationVariables, type DeleteContactMutationVariables, type DeleteCourseMutationVariables, type DeleteCompensationMutationVariables, type DeleteDonationCampaignMutationVariables, type DeleteEmploymentMutationVariables, type DeleteFormMutationVariables, type DeleteKbArticleMutationVariables, type DeleteKbCollectionMutationVariables, type DeleteNoteMutationVariables, type DeleteSpaceMutationVariables, type DeleteTaskMutationVariables, type UpdateChannelMutationVariables, type UpdateCompensationMutationVariables, type UpdateCourseMutationVariables, type UpdateDealMutationVariables, type UpdateDonationCampaignMutationVariables, type UpdateEmployeeMutationVariables, type UpdateEmploymentMutationVariables, type UpdateEventMutationVariables, type UpdateFormMutationVariables, type UpdateKbArticleMutationVariables, type UpdateKbCollectionMutationVariables, type UpdateNoteMutationVariables, type UpdateSpaceMutationVariables, type UpdateStoryMutationVariables, type UpdateTaskMutationVariables } from "./generated/index.js";
3
+ /**
4
+ * Create a course from `{ input: { attributes } }`. Returns the payload (with
5
+ * `errors`) or null.
6
+ */
3
7
  export declare function createCourse(c: UiduClient, v: CreateCourseMutationVariables): Promise<{
4
8
  __typename?: "CreateCoursePayload";
5
9
  course?: {
@@ -13,6 +17,10 @@ export declare function createCourse(c: UiduClient, v: CreateCourseMutationVaria
13
17
  type: string;
14
18
  }>;
15
19
  } | null>;
20
+ /**
21
+ * Update a course: `{ input: { id, attributes } }`. Returns the payload (with
22
+ * `errors`) or null.
23
+ */
16
24
  export declare function updateCourse(c: UiduClient, v: UpdateCourseMutationVariables): Promise<{
17
25
  __typename?: "UpdateCoursePayload";
18
26
  course?: {
@@ -26,6 +34,10 @@ export declare function updateCourse(c: UiduClient, v: UpdateCourseMutationVaria
26
34
  type: string;
27
35
  }>;
28
36
  } | null>;
37
+ /**
38
+ * Delete a course by `{ input: { id } }`. Returns the payload (with `errors`)
39
+ * or null.
40
+ */
29
41
  export declare function deleteCourse(c: UiduClient, v: DeleteCourseMutationVariables): Promise<{
30
42
  __typename?: "DeleteCoursePayload";
31
43
  course?: {
@@ -39,6 +51,10 @@ export declare function deleteCourse(c: UiduClient, v: DeleteCourseMutationVaria
39
51
  type: string;
40
52
  }>;
41
53
  } | null>;
54
+ /**
55
+ * Create a form, questions included via `attributes.formQuestionsAttributes`.
56
+ * Returns the payload (with `errors`) or null. The new form is at `form.node`.
57
+ */
42
58
  export declare function createForm(c: UiduClient, v: CreateFormMutationVariables): Promise<{
43
59
  __typename?: "CreateFormPayload";
44
60
  form?: {
@@ -55,6 +71,10 @@ export declare function createForm(c: UiduClient, v: CreateFormMutationVariables
55
71
  type: string;
56
72
  }>;
57
73
  } | null>;
74
+ /**
75
+ * Update a form: `{ input: { id, attributes } }`. Returns the payload (with
76
+ * `errors`) or null.
77
+ */
58
78
  export declare function updateForm(c: UiduClient, v: UpdateFormMutationVariables): Promise<{
59
79
  __typename?: "UpdateFormPayload";
60
80
  form?: {
@@ -68,6 +88,10 @@ export declare function updateForm(c: UiduClient, v: UpdateFormMutationVariables
68
88
  type: string;
69
89
  }>;
70
90
  } | null>;
91
+ /**
92
+ * Delete a form by `{ input: { id } }`. Returns the payload (with `errors`) or
93
+ * null.
94
+ */
71
95
  export declare function deleteForm(c: UiduClient, v: DeleteFormMutationVariables): Promise<{
72
96
  __typename?: "DeleteFormPayload";
73
97
  form?: {
@@ -81,6 +105,10 @@ export declare function deleteForm(c: UiduClient, v: DeleteFormMutationVariables
81
105
  type: string;
82
106
  }>;
83
107
  } | null>;
108
+ /**
109
+ * Create a CRM contact from `{ input: { attributes } }`. Returns the payload
110
+ * (with `errors`) or null.
111
+ */
84
112
  export declare function createContact(c: UiduClient, v: CreateContactMutationVariables): Promise<{
85
113
  __typename?: "CreateContactPayload";
86
114
  contact?: {
@@ -94,6 +122,10 @@ export declare function createContact(c: UiduClient, v: CreateContactMutationVar
94
122
  type: string;
95
123
  }>;
96
124
  } | null>;
125
+ /**
126
+ * Delete a contact by `{ input: { id } }`. Returns the payload (with `errors`)
127
+ * or null.
128
+ */
97
129
  export declare function deleteContact(c: UiduClient, v: DeleteContactMutationVariables): Promise<{
98
130
  __typename?: "DeleteContactPayload";
99
131
  contact?: {
@@ -107,6 +139,10 @@ export declare function deleteContact(c: UiduClient, v: DeleteContactMutationVar
107
139
  type: string;
108
140
  }>;
109
141
  } | null>;
142
+ /**
143
+ * Create a deal in a pipeline (`attributes.pipelineId`, `statusId`). Returns
144
+ * the payload (with `errors`) or null. The new deal is at `deal.node`.
145
+ */
110
146
  export declare function createDeal(c: UiduClient, v: CreateDealMutationVariables): Promise<{
111
147
  __typename?: "CreateDealPayload";
112
148
  deal?: {
@@ -123,6 +159,10 @@ export declare function createDeal(c: UiduClient, v: CreateDealMutationVariables
123
159
  type: string;
124
160
  }>;
125
161
  } | null>;
162
+ /**
163
+ * Update a deal, e.g. move it to another `statusId`: `{ input: { id,
164
+ * attributes } }`. Returns the payload (with `errors`) or null.
165
+ */
126
166
  export declare function updateDeal(c: UiduClient, v: UpdateDealMutationVariables): Promise<{
127
167
  __typename?: "UpdateDealPayload";
128
168
  deal?: {
@@ -136,6 +176,10 @@ export declare function updateDeal(c: UiduClient, v: UpdateDealMutationVariables
136
176
  type: string;
137
177
  }>;
138
178
  } | null>;
179
+ /**
180
+ * Create the HR record for a workspace user (`attributes.userId`). Returns the
181
+ * payload (with `errors`) or null. The new employee is at `employee.node`.
182
+ */
139
183
  export declare function createEmployee(c: UiduClient, v: CreateEmployeeMutationVariables): Promise<{
140
184
  __typename?: "CreateEmployeePayload";
141
185
  employee?: {
@@ -159,6 +203,10 @@ export declare function createEmployee(c: UiduClient, v: CreateEmployeeMutationV
159
203
  type: string;
160
204
  }>;
161
205
  } | null>;
206
+ /**
207
+ * Update an employee's HR record (code, kiosk PIN, time-clock flags): `{
208
+ * input: { id, attributes } }`. Returns the payload (with `errors`) or null.
209
+ */
162
210
  export declare function updateEmployee(c: UiduClient, v: UpdateEmployeeMutationVariables): Promise<{
163
211
  __typename?: "UpdateEmployeePayload";
164
212
  employee?: {
@@ -173,6 +221,11 @@ export declare function updateEmployee(c: UiduClient, v: UpdateEmployeeMutationV
173
221
  type: string;
174
222
  }>;
175
223
  } | null>;
224
+ /**
225
+ * Hire: open a new employment (contract) for `attributes.employeeId` with its
226
+ * start date, kind, role and hours. Returns the payload (with `errors`) or
227
+ * null. The new employment is at `employment.node`.
228
+ */
176
229
  export declare function createEmployment(c: UiduClient, v: CreateEmploymentMutationVariables): Promise<{
177
230
  __typename?: "CreateEmploymentPayload";
178
231
  employment?: {
@@ -199,6 +252,10 @@ export declare function createEmployment(c: UiduClient, v: CreateEmploymentMutat
199
252
  type: string;
200
253
  }>;
201
254
  } | null>;
255
+ /**
256
+ * Update an employment: `{ input: { id, attributes } }`; to end one, prefer
257
+ * `terminateEmployment`. Returns the payload (with `errors`) or null.
258
+ */
202
259
  export declare function updateEmployment(c: UiduClient, v: UpdateEmploymentMutationVariables): Promise<{
203
260
  __typename?: "UpdateEmploymentPayload";
204
261
  employment?: {
@@ -223,6 +280,10 @@ export declare function updateEmployment(c: UiduClient, v: UpdateEmploymentMutat
223
280
  type: string;
224
281
  }>;
225
282
  } | null>;
283
+ /**
284
+ * Delete an employment by `{ input: { id } }` (to end a contract, use
285
+ * `terminateEmployment` instead). Returns the payload (with `errors`) or null.
286
+ */
226
287
  export declare function deleteEmployment(c: UiduClient, v: DeleteEmploymentMutationVariables): Promise<{
227
288
  __typename?: "DeleteEmploymentPayload";
228
289
  employment?: {
@@ -239,7 +300,10 @@ export declare function deleteEmployment(c: UiduClient, v: DeleteEmploymentMutat
239
300
  /**
240
301
  * Terminate (cessazione) an employment by closing it with an end date and
241
302
  * reason. Thin semantic wrapper over {@link updateEmployment}.
242
- * `endReason` is one of: resignation, termination, contract_end, retirement, other.
303
+ * `endReason` is one of: resignation, termination, contract_end, retirement,
304
+ * other, resignation_just_cause, dismissal_just_cause,
305
+ * dismissal_subjective_reason, dismissal_objective_reason, collective_dismissal,
306
+ * mutual_agreement, probation_failed, death, business_closure.
243
307
  */
244
308
  export declare function terminateEmployment(c: UiduClient, args: {
245
309
  id: string;
@@ -269,6 +333,11 @@ export declare function terminateEmployment(c: UiduClient, args: {
269
333
  type: string;
270
334
  }>;
271
335
  } | null>;
336
+ /**
337
+ * Record a time-clock punch (`beginsAt`, optional `finishesAt`, `resourceId`).
338
+ * Returns the payload (with `errors`) or null. The new punch is at
339
+ * `timeClock.node`.
340
+ */
272
341
  export declare function createTimeClock(c: UiduClient, v: CreateTimeClockMutationVariables): Promise<{
273
342
  __typename?: "CreateTimeClockPayload";
274
343
  timeClock?: {
@@ -288,6 +357,11 @@ export declare function createTimeClock(c: UiduClient, v: CreateTimeClockMutatio
288
357
  type: string;
289
358
  }>;
290
359
  } | null>;
360
+ /**
361
+ * Add a pay item to an employment (`attributes.employmentId`, `amount`,
362
+ * `currency`, `frequency`, `effectiveFrom`). Returns the payload (with
363
+ * `errors`) or null. The new item is at `compensation.node`.
364
+ */
291
365
  export declare function createCompensation(c: UiduClient, v: CreateCompensationMutationVariables): Promise<{
292
366
  __typename?: "CreateCompensationPayload";
293
367
  compensation?: {
@@ -309,6 +383,10 @@ export declare function createCompensation(c: UiduClient, v: CreateCompensationM
309
383
  type: string;
310
384
  }>;
311
385
  } | null>;
386
+ /**
387
+ * Update a pay item: `{ input: { id, attributes } }`. Returns the payload
388
+ * (with `errors`) or null.
389
+ */
312
390
  export declare function updateCompensation(c: UiduClient, v: UpdateCompensationMutationVariables): Promise<{
313
391
  __typename?: "UpdateCompensationPayload";
314
392
  compensation?: {
@@ -327,6 +405,10 @@ export declare function updateCompensation(c: UiduClient, v: UpdateCompensationM
327
405
  type: string;
328
406
  }>;
329
407
  } | null>;
408
+ /**
409
+ * Delete a pay item by `{ input: { id } }`. Returns the payload (with
410
+ * `errors`) or null.
411
+ */
330
412
  export declare function deleteCompensation(c: UiduClient, v: DeleteCompensationMutationVariables): Promise<{
331
413
  __typename?: "DeleteCompensationPayload";
332
414
  compensation?: {
@@ -340,6 +422,10 @@ export declare function deleteCompensation(c: UiduClient, v: DeleteCompensationM
340
422
  type: string;
341
423
  }>;
342
424
  } | null>;
425
+ /**
426
+ * Create a knowledge-base collection. Returns the payload (with `errors`) or
427
+ * null. The new collection is at `kbCollection.node`.
428
+ */
343
429
  export declare function createKbCollection(c: UiduClient, v: CreateKbCollectionMutationVariables): Promise<{
344
430
  __typename?: "CreateKbCollectionPayload";
345
431
  kbCollection?: {
@@ -356,6 +442,10 @@ export declare function createKbCollection(c: UiduClient, v: CreateKbCollectionM
356
442
  type: string;
357
443
  }>;
358
444
  } | null>;
445
+ /**
446
+ * Update a knowledge-base collection: `{ input: { id, attributes } }`. Returns
447
+ * the payload (with `errors`) or null.
448
+ */
359
449
  export declare function updateKbCollection(c: UiduClient, v: UpdateKbCollectionMutationVariables): Promise<{
360
450
  __typename?: "UpdateKbCollectionPayload";
361
451
  kbCollection?: {
@@ -369,6 +459,10 @@ export declare function updateKbCollection(c: UiduClient, v: UpdateKbCollectionM
369
459
  type: string;
370
460
  }>;
371
461
  } | null>;
462
+ /**
463
+ * Delete a knowledge-base collection by `{ input: { id } }`. Returns the
464
+ * payload (with `errors`) or null.
465
+ */
372
466
  export declare function deleteKbCollection(c: UiduClient, v: DeleteKbCollectionMutationVariables): Promise<{
373
467
  __typename?: "DeleteKbCollectionPayload";
374
468
  kbCollection?: {
@@ -382,6 +476,10 @@ export declare function deleteKbCollection(c: UiduClient, v: DeleteKbCollectionM
382
476
  type: string;
383
477
  }>;
384
478
  } | null>;
479
+ /**
480
+ * Create a knowledge-base article in `attributes.kbCollectionId`. Returns the
481
+ * payload (with `errors`) or null. The new article is at `kbArticle.node`.
482
+ */
385
483
  export declare function createKbArticle(c: UiduClient, v: CreateKbArticleMutationVariables): Promise<{
386
484
  __typename?: "CreateKbArticlePayload";
387
485
  kbArticle?: {
@@ -398,6 +496,10 @@ export declare function createKbArticle(c: UiduClient, v: CreateKbArticleMutatio
398
496
  type: string;
399
497
  }>;
400
498
  } | null>;
499
+ /**
500
+ * Update a knowledge-base article: `{ input: { id, attributes } }`. Returns
501
+ * the payload (with `errors`) or null.
502
+ */
401
503
  export declare function updateKbArticle(c: UiduClient, v: UpdateKbArticleMutationVariables): Promise<{
402
504
  __typename?: "UpdateKbArticlePayload";
403
505
  kbArticle?: {
@@ -411,6 +513,10 @@ export declare function updateKbArticle(c: UiduClient, v: UpdateKbArticleMutatio
411
513
  type: string;
412
514
  }>;
413
515
  } | null>;
516
+ /**
517
+ * Delete a knowledge-base article by `{ input: { id } }`. Returns the payload
518
+ * (with `errors`) or null.
519
+ */
414
520
  export declare function deleteKbArticle(c: UiduClient, v: DeleteKbArticleMutationVariables): Promise<{
415
521
  __typename?: "DeleteKbArticlePayload";
416
522
  kbArticle?: {
@@ -424,6 +530,10 @@ export declare function deleteKbArticle(c: UiduClient, v: DeleteKbArticleMutatio
424
530
  type: string;
425
531
  }>;
426
532
  } | null>;
533
+ /**
534
+ * Create a help-center channel. Returns the payload (with `errors`) or null.
535
+ * The new channel is at `channel.node`.
536
+ */
427
537
  export declare function createChannel(c: UiduClient, v: CreateChannelMutationVariables): Promise<{
428
538
  __typename?: "CreateChannelPayload";
429
539
  channel?: {
@@ -440,6 +550,10 @@ export declare function createChannel(c: UiduClient, v: CreateChannelMutationVar
440
550
  type: string;
441
551
  }>;
442
552
  } | null>;
553
+ /**
554
+ * Update a help-center channel: `{ input: { id, attributes } }`. Returns the
555
+ * payload (with `errors`) or null.
556
+ */
443
557
  export declare function updateChannel(c: UiduClient, v: UpdateChannelMutationVariables): Promise<{
444
558
  __typename?: "UpdateChannelPayload";
445
559
  channel?: {
@@ -453,6 +567,10 @@ export declare function updateChannel(c: UiduClient, v: UpdateChannelMutationVar
453
567
  type: string;
454
568
  }>;
455
569
  } | null>;
570
+ /**
571
+ * Delete a help-center channel by `{ input: { id } }`. Returns the payload
572
+ * (with `errors`) or null.
573
+ */
456
574
  export declare function deleteChannel(c: UiduClient, v: DeleteChannelMutationVariables): Promise<{
457
575
  __typename?: "DeleteChannelPayload";
458
576
  channel?: {
@@ -466,6 +584,10 @@ export declare function deleteChannel(c: UiduClient, v: DeleteChannelMutationVar
466
584
  type: string;
467
585
  }>;
468
586
  } | null>;
587
+ /**
588
+ * Update an event: `{ input: { id, attributes } }` (create it with
589
+ * `createEvent`). Returns the payload (with `errors`) or null.
590
+ */
469
591
  export declare function updateEvent(c: UiduClient, v: UpdateEventMutationVariables): Promise<{
470
592
  __typename?: "UpdateEventPayload";
471
593
  event?: {
@@ -479,6 +601,10 @@ export declare function updateEvent(c: UiduClient, v: UpdateEventMutationVariabl
479
601
  type: string;
480
602
  }>;
481
603
  } | null>;
604
+ /**
605
+ * Update a story: `{ input: { id, attributes } }` (create it with
606
+ * `createStory`). Returns the payload (with `errors`) or null.
607
+ */
482
608
  export declare function updateStory(c: UiduClient, v: UpdateStoryMutationVariables): Promise<{
483
609
  __typename?: "UpdateStoryPayload";
484
610
  story?: {
@@ -492,6 +618,10 @@ export declare function updateStory(c: UiduClient, v: UpdateStoryMutationVariabl
492
618
  type: string;
493
619
  }>;
494
620
  } | null>;
621
+ /**
622
+ * Update a donation campaign: `{ input: { id, attributes } }`. Returns the
623
+ * payload (with `errors`) or null.
624
+ */
495
625
  export declare function updateDonationCampaign(c: UiduClient, v: UpdateDonationCampaignMutationVariables): Promise<{
496
626
  __typename?: "UpdateDonationCampaignPayload";
497
627
  donationCampaign?: {
@@ -505,6 +635,10 @@ export declare function updateDonationCampaign(c: UiduClient, v: UpdateDonationC
505
635
  type: string;
506
636
  }>;
507
637
  } | null>;
638
+ /**
639
+ * Delete a donation campaign by `{ input: { id } }`. Returns the payload (with
640
+ * `errors`) or null.
641
+ */
508
642
  export declare function deleteDonationCampaign(c: UiduClient, v: DeleteDonationCampaignMutationVariables): Promise<{
509
643
  __typename?: "DeleteDonationCampaignPayload";
510
644
  donationCampaign?: {
@@ -518,6 +652,10 @@ export declare function deleteDonationCampaign(c: UiduClient, v: DeleteDonationC
518
652
  type: string;
519
653
  }>;
520
654
  } | null>;
655
+ /**
656
+ * Update a task, e.g. its `statusId` or dates: `{ input: { id, attributes }
657
+ * }`. Returns the payload (with `errors`) or null.
658
+ */
521
659
  export declare function updateTask(c: UiduClient, v: UpdateTaskMutationVariables): Promise<{
522
660
  __typename?: "UpdateTaskPayload";
523
661
  task?: {
@@ -531,6 +669,10 @@ export declare function updateTask(c: UiduClient, v: UpdateTaskMutationVariables
531
669
  type: string;
532
670
  }>;
533
671
  } | null>;
672
+ /**
673
+ * Delete a task by `{ input: { id } }`. Returns the payload (with `errors`) or
674
+ * null.
675
+ */
534
676
  export declare function deleteTask(c: UiduClient, v: DeleteTaskMutationVariables): Promise<{
535
677
  __typename?: "DeleteTaskPayload";
536
678
  task?: {
@@ -544,6 +686,10 @@ export declare function deleteTask(c: UiduClient, v: DeleteTaskMutationVariables
544
686
  type: string;
545
687
  }>;
546
688
  } | null>;
689
+ /**
690
+ * Update a note: `{ input: { id, attributes } }`. Returns the payload (with
691
+ * `errors`) or null.
692
+ */
547
693
  export declare function updateNote(c: UiduClient, v: UpdateNoteMutationVariables): Promise<{
548
694
  __typename?: "UpdateNotePayload";
549
695
  note?: {
@@ -557,6 +703,10 @@ export declare function updateNote(c: UiduClient, v: UpdateNoteMutationVariables
557
703
  type: string;
558
704
  }>;
559
705
  } | null>;
706
+ /**
707
+ * Delete a note by `{ input: { id } }`. Returns the payload (with `errors`) or
708
+ * null.
709
+ */
560
710
  export declare function deleteNote(c: UiduClient, v: DeleteNoteMutationVariables): Promise<{
561
711
  __typename?: "DeleteNotePayload";
562
712
  note?: {
@@ -570,6 +720,10 @@ export declare function deleteNote(c: UiduClient, v: DeleteNoteMutationVariables
570
720
  type: string;
571
721
  }>;
572
722
  } | null>;
723
+ /**
724
+ * Update a space: `{ input: { id, attributes } }`. Returns the payload (with
725
+ * `errors`) or null.
726
+ */
573
727
  export declare function updateSpace(c: UiduClient, v: UpdateSpaceMutationVariables): Promise<{
574
728
  __typename?: "UpdateSpacePayload";
575
729
  space?: {
@@ -583,6 +737,10 @@ export declare function updateSpace(c: UiduClient, v: UpdateSpaceMutationVariabl
583
737
  type: string;
584
738
  }>;
585
739
  } | null>;
740
+ /**
741
+ * Delete a space by `{ input: { id } }`. Returns the payload (with `errors`)
742
+ * or null.
743
+ */
586
744
  export declare function deleteSpace(c: UiduClient, v: DeleteSpaceMutationVariables): Promise<{
587
745
  __typename?: "DeleteSpacePayload";
588
746
  space?: {
@@ -1,5 +1,9 @@
1
1
  import type { UiduClient } from "./client.js";
2
2
  import { type CreateNoteMutationVariables } from "./generated/index.js";
3
+ /**
4
+ * Create a note. Returns the payload (with `errors`) or null; the new note is
5
+ * at `note.node`.
6
+ */
3
7
  export declare function createNote(client: UiduClient, variables: CreateNoteMutationVariables): Promise<{
4
8
  __typename?: "CreateNotePayload";
5
9
  note?: {
@@ -5,6 +5,10 @@ export type Circle = NonNullable<NonNullable<NonNullable<NonNullable<NonNullable
5
5
  export type Office = NonNullable<NonNullable<NonNullable<NonNullable<NonNullable<ListOfficesQuery['currentWorkspace']>['offices']>['edges']>[number]>['node']>;
6
6
  /** A `Kind` record — CCNLs (national collective labor contracts) are Kinds. */
7
7
  export type Kind = NonNullable<NonNullable<NonNullable<NonNullable<NonNullable<ListKindsQuery['currentWorkspace']>['kinds']>['edges']>[number]>['node']>;
8
+ /**
9
+ * The workspace's employees with their current employment, as a flat array;
10
+ * page with `first`/`after`.
11
+ */
8
12
  export declare function listEmployees(client: UiduClient, variables?: ListEmployeesQueryVariables): Promise<{
9
13
  __typename?: "Employee";
10
14
  id: string;
@@ -30,6 +34,10 @@ export declare function listEmployees(client: UiduClient, variables?: ListEmploy
30
34
  } | null;
31
35
  } | null;
32
36
  }[]>;
37
+ /**
38
+ * One employee with current employment, today's time clocks and the shifts of
39
+ * the week starting `weekStartingAt` (see `weekStartFor`), or null.
40
+ */
33
41
  export declare function getEmployee(client: UiduClient, variables: GetEmployeeQueryVariables): Promise<Employee | null>;
34
42
  /**
35
43
  * Compute the Monday of the week containing `date` as an ISO8601 date string.