@uidu/client 3.3.0 → 3.4.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,35 @@
1
1
  # @uidu/client
2
2
 
3
+ ## 3.4.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 5a31264: Add compensation writes and surface CCNL + pay on employment history.
8
+
9
+ New `createCompensation`, `updateCompensation` and `deleteCompensation` cover an
10
+ employment's pay items (amount, currency, `frequency` — hourly/monthly/annual,
11
+ `componentType` — base/allowance/recurring_bonus, `reason`, `effectiveFrom`).
12
+ `listEmploymentHistory` now also returns each contract's `ccnl` and its
13
+ `compensations` (most-recent effective date first), and `EmploymentRecord`
14
+ gains `ccnl` and `compensations`, with a new exported `CompensationRecord` type.
15
+
16
+ Together with the existing `ccnlId` on employment attributes and `listCcnls`,
17
+ this makes CCNL and compensation first-class in the SDK.
18
+
19
+ - 2a53025: Add `jobs` (announcements) and `applications` API integrations.
20
+
21
+ `jobs` is a derived view over `calls`: `listJobs`/`getJob` return calls whose
22
+ `kind` is `job`, with the exported `Job` type. `applications` is a first-class
23
+ domain backed by new `ListApplications` / `CreateApplication` operations —
24
+ `listApplications` (Bearer, private candidate data), `createApplication`
25
+ (the public apply path, links a contact + form response to a job via
26
+ `applicableId`), plus the `Application` type and `ListApplicationsDocument`.
27
+
28
+ `@uidu/react` gains the pure `formatSalaryRange(job)` helper. These were added
29
+ end-to-end (client → CLI → react → demo) as the reference implementation of the
30
+ new [`docs/adding-an-api-integration.md`](../docs/adding-an-api-integration.md)
31
+ process.
32
+
3
33
  ## 3.3.0
4
34
 
5
35
  ### Minor Changes
@@ -0,0 +1,57 @@
1
+ import type { UiduClient } from "./client.js";
2
+ import { type CreateApplicationMutationVariables, type ListApplicationsQuery, type ListApplicationsQueryVariables } from "./generated/index.js";
3
+ /**
4
+ * An application submitted to a job posting (a {@link Job}).
5
+ *
6
+ * Unlike `jobs`, applications are a *first-class* GraphQL type with their own
7
+ * operations (`ListApplications`, `CreateApplication`). The `*Document`s below
8
+ * are produced by codegen from `src/queries/applications/*.graphql` — run
9
+ * `yarn workspace @uidu/client codegen` after editing those files.
10
+ *
11
+ * Reads (`listApplications`) require a Bearer token (`apiKey`): applications
12
+ * hold private candidate data. Writes (`createApplication`) are the public
13
+ * "apply to this job" path.
14
+ */
15
+ export type Application = NonNullable<NonNullable<NonNullable<NonNullable<ListApplicationsQuery['currentWorkspace']>['applications']['edges']>[number]>['node']>;
16
+ /** List applications across the workspace (requires a Bearer token). */
17
+ export declare function listApplications(client: UiduClient, variables?: ListApplicationsQueryVariables): Promise<Application[]>;
18
+ /**
19
+ * Submit an application to a job. Pass `attributes.applicableId` (the job's id)
20
+ * plus `contactAttributes` and/or `formResponseAttributes`. Returns the
21
+ * mutation payload as-is (including any `errors`) rather than throwing.
22
+ */
23
+ export declare function createApplication(client: UiduClient, variables: CreateApplicationMutationVariables): Promise<{
24
+ __typename?: "CreateApplicationPayload";
25
+ errors: Array<{
26
+ __typename?: "Error";
27
+ key: string;
28
+ name: string;
29
+ type: string;
30
+ }>;
31
+ application?: {
32
+ __typename?: "Application";
33
+ id: string;
34
+ aasmState?: string | null;
35
+ summary?: string | null;
36
+ completedAt?: any | null;
37
+ createdAt: any;
38
+ contact?: {
39
+ __typename?: "Contact";
40
+ id: string;
41
+ humanName: string;
42
+ email?: string | null;
43
+ } | null;
44
+ applicable: {
45
+ __typename: "Call";
46
+ id: string;
47
+ name?: string | null;
48
+ kind: import("./generated/index.js").CallKind;
49
+ } | {
50
+ __typename: "Grant";
51
+ };
52
+ formResponse?: {
53
+ __typename?: "FormResponse";
54
+ id: string;
55
+ } | null;
56
+ } | null;
57
+ } | null>;
@@ -42295,6 +42295,100 @@ export type WorkspaceTaggingEdge = {
42295
42295
  /** The item at the end of the edge. */
42296
42296
  node?: Maybe<WorkspaceTagging>;
42297
42297
  };
42298
+ export type CreateApplicationMutationVariables = Exact<{
42299
+ input: CreateApplicationInput;
42300
+ }>;
42301
+ export type CreateApplicationMutation = {
42302
+ __typename?: 'Mutation';
42303
+ createApplication?: {
42304
+ __typename?: 'CreateApplicationPayload';
42305
+ errors: Array<{
42306
+ __typename?: 'Error';
42307
+ key: string;
42308
+ name: string;
42309
+ type: string;
42310
+ }>;
42311
+ application?: {
42312
+ __typename?: 'Application';
42313
+ id: string;
42314
+ aasmState?: string | null;
42315
+ summary?: string | null;
42316
+ completedAt?: any | null;
42317
+ createdAt: any;
42318
+ contact?: {
42319
+ __typename?: 'Contact';
42320
+ id: string;
42321
+ humanName: string;
42322
+ email?: string | null;
42323
+ } | null;
42324
+ applicable: {
42325
+ __typename: 'Call';
42326
+ id: string;
42327
+ name?: string | null;
42328
+ kind: CallKind;
42329
+ } | {
42330
+ __typename: 'Grant';
42331
+ };
42332
+ formResponse?: {
42333
+ __typename?: 'FormResponse';
42334
+ id: string;
42335
+ } | null;
42336
+ } | null;
42337
+ } | null;
42338
+ };
42339
+ export type ListApplicationsQueryVariables = Exact<{
42340
+ first?: InputMaybe<Scalars['Int']['input']>;
42341
+ after?: InputMaybe<Scalars['String']['input']>;
42342
+ }>;
42343
+ export type ListApplicationsQuery = {
42344
+ __typename?: 'Query';
42345
+ currentWorkspace?: {
42346
+ __typename?: 'Workspace';
42347
+ applications: {
42348
+ __typename?: 'ApplicationConnection';
42349
+ pageInfo: {
42350
+ __typename?: 'PageInfo';
42351
+ hasNextPage: boolean;
42352
+ endCursor?: string | null;
42353
+ };
42354
+ edges?: Array<{
42355
+ __typename?: 'ApplicationEdge';
42356
+ node?: {
42357
+ __typename?: 'Application';
42358
+ id: string;
42359
+ aasmState?: string | null;
42360
+ summary?: string | null;
42361
+ completedAt?: any | null;
42362
+ createdAt: any;
42363
+ status?: {
42364
+ __typename?: 'Status';
42365
+ id: string;
42366
+ name?: string | null;
42367
+ color?: string | null;
42368
+ } | null;
42369
+ contact?: {
42370
+ __typename?: 'Contact';
42371
+ id: string;
42372
+ humanName: string;
42373
+ email?: string | null;
42374
+ } | null;
42375
+ applicable: {
42376
+ __typename: 'Call';
42377
+ id: string;
42378
+ name?: string | null;
42379
+ kind: CallKind;
42380
+ } | {
42381
+ __typename: 'Grant';
42382
+ };
42383
+ formResponse?: {
42384
+ __typename?: 'FormResponse';
42385
+ id: string;
42386
+ } | null;
42387
+ } | null;
42388
+ } | null> | null;
42389
+ };
42390
+ } | null;
42391
+ };
42298
42392
  export type GetBookingQueryVariables = Exact<{
42299
42393
  id: Scalars['ID']['input'];
42300
42394
  }>;
@@ -44563,6 +44657,76 @@ export type DeleteNoteMutation = {
44563
44657
  }>;
44564
44658
  } | null;
44565
44659
  };
44660
+ export type CreateCompensationMutationVariables = Exact<{
44661
+ input: CreateCompensationInput;
44662
+ }>;
44663
+ export type CreateCompensationMutation = {
44664
+ __typename?: 'Mutation';
44665
+ createCompensation?: {
44666
+ __typename?: 'CreateCompensationPayload';
44667
+ compensation?: {
44668
+ __typename?: 'CompensationEdge';
44669
+ node?: {
44670
+ __typename?: 'Compensation';
44671
+ id: string;
44672
+ amount: number;
44673
+ currency: string;
44674
+ frequency: string;
44675
+ componentType: string;
44676
+ effectiveFrom: any;
44677
+ } | null;
44678
+ } | null;
44679
+ errors: Array<{
44680
+ __typename?: 'Error';
44681
+ key: string;
44682
+ name: string;
44683
+ type: string;
44684
+ }>;
44685
+ } | null;
44686
+ };
44687
+ export type UpdateCompensationMutationVariables = Exact<{
44688
+ input: UpdateCompensationInput;
44689
+ }>;
44690
+ export type UpdateCompensationMutation = {
44691
+ __typename?: 'Mutation';
44692
+ updateCompensation?: {
44693
+ __typename?: 'UpdateCompensationPayload';
44694
+ compensation?: {
44695
+ __typename?: 'Compensation';
44696
+ id: string;
44697
+ amount: number;
44698
+ currency: string;
44699
+ frequency: string;
44700
+ componentType: string;
44701
+ effectiveFrom: any;
44702
+ } | null;
44703
+ errors: Array<{
44704
+ __typename?: 'Error';
44705
+ key: string;
44706
+ name: string;
44707
+ type: string;
44708
+ }>;
44709
+ } | null;
44710
+ };
44711
+ export type DeleteCompensationMutationVariables = Exact<{
44712
+ input: DeleteCompensationInput;
44713
+ }>;
44714
+ export type DeleteCompensationMutation = {
44715
+ __typename?: 'Mutation';
44716
+ deleteCompensation?: {
44717
+ __typename?: 'DeleteCompensationPayload';
44718
+ compensation?: {
44719
+ __typename?: 'Compensation';
44720
+ id: string;
44721
+ } | null;
44722
+ errors: Array<{
44723
+ __typename?: 'Error';
44724
+ key: string;
44725
+ name: string;
44726
+ type: string;
44727
+ }>;
44728
+ } | null;
44729
+ };
44566
44730
  export type GetEmployeeQueryVariables = Exact<{
44567
44731
  id: Scalars['ID']['input'];
44568
44732
  weekStartingAt: Scalars['ISO8601Date']['input'];
@@ -44732,6 +44896,26 @@ export type ListEmploymentHistoryQuery = {
44732
44896
  endReason?: string | null;
44733
44897
  jobTitle?: string | null;
44734
44898
  contractType?: string | null;
44899
+ ccnl?: {
44900
+ __typename?: 'Kind';
44901
+ id: string;
44902
+ name?: string | null;
44903
+ } | null;
44904
+ compensations: {
44905
+ __typename?: 'CompensationConnection';
44906
+ edges?: Array<{
44907
+ __typename?: 'CompensationEdge';
44908
+ node?: {
44909
+ __typename?: 'Compensation';
44910
+ id: string;
44911
+ amount: number;
44912
+ currency: string;
44913
+ frequency: string;
44914
+ componentType: string;
44915
+ effectiveFrom: any;
44916
+ } | null;
44917
+ } | null> | null;
44918
+ };
44735
44919
  } | null;
44736
44920
  } | null> | null;
44737
44921
  };
@@ -45305,6 +45489,8 @@ export type DeleteTaskMutation = {
45305
45489
  };
45306
45490
  export declare const FormFieldsFragmentDoc: DocumentNode<FormFieldsFragment, unknown>;
45307
45491
  export declare const FormResponseFieldsFragmentDoc: DocumentNode<FormResponseFieldsFragment, unknown>;
45492
+ export declare const CreateApplicationDocument: DocumentNode<CreateApplicationMutation, CreateApplicationMutationVariables>;
45493
+ export declare const ListApplicationsDocument: DocumentNode<ListApplicationsQuery, ListApplicationsQueryVariables>;
45308
45494
  export declare const GetBookingDocument: DocumentNode<GetBookingQuery, GetBookingQueryVariables>;
45309
45495
  export declare const GetCalendarDocument: DocumentNode<GetCalendarQuery, GetCalendarQueryVariables>;
45310
45496
  export declare const GetCalendarEventDocument: DocumentNode<GetCalendarEventQuery, GetCalendarEventQueryVariables>;
@@ -45375,6 +45561,9 @@ export declare const ListKbCollectionsDocument: DocumentNode<ListKbCollectionsQu
45375
45561
  export declare const CreateNoteDocument: DocumentNode<CreateNoteMutation, CreateNoteMutationVariables>;
45376
45562
  export declare const UpdateNoteDocument: DocumentNode<UpdateNoteMutation, UpdateNoteMutationVariables>;
45377
45563
  export declare const DeleteNoteDocument: DocumentNode<DeleteNoteMutation, DeleteNoteMutationVariables>;
45564
+ export declare const CreateCompensationDocument: DocumentNode<CreateCompensationMutation, CreateCompensationMutationVariables>;
45565
+ export declare const UpdateCompensationDocument: DocumentNode<UpdateCompensationMutation, UpdateCompensationMutationVariables>;
45566
+ export declare const DeleteCompensationDocument: DocumentNode<DeleteCompensationMutation, DeleteCompensationMutationVariables>;
45378
45567
  export declare const GetEmployeeDocument: DocumentNode<GetEmployeeQuery, GetEmployeeQueryVariables>;
45379
45568
  export declare const ListCirclesDocument: DocumentNode<ListCirclesQuery, ListCirclesQueryVariables>;
45380
45569
  export declare const ListEmployeesDocument: DocumentNode<ListEmployeesQuery, ListEmployeesQueryVariables>;
@@ -3,14 +3,14 @@ export { UiduError } from "./types.js";
3
3
  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
- export { ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, } from "./generated/index.js";
6
+ export { ListApplicationsDocument, ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, } from "./generated/index.js";
7
7
  export { getPage, listPages, getTemplate, createProject, createPage, createPageBlock, createFieldValue, } from "./cms.js";
8
8
  export type { Page, Template } from "./cms.js";
9
9
  export { createWorkspace, generateWorkspaceApiCredentials, } from "./system.js";
10
10
  export { createSpace } from "./spaces.js";
11
11
  export { createTask } from "./tasks.js";
12
12
  export { createNote } from "./notes.js";
13
- export { createCourse, updateCourse, deleteCourse, createForm, updateForm, deleteForm, createContact, deleteContact, createDeal, updateDeal, createKbCollection, updateKbCollection, deleteKbCollection, createKbArticle, updateKbArticle, deleteKbArticle, createChannel, updateChannel, deleteChannel, updateEvent, updateStory, updateDonationCampaign, deleteDonationCampaign, updateTask, deleteTask, updateNote, deleteNote, updateSpace, deleteSpace, createEmployee, updateEmployee, createEmployment, updateEmployment, deleteEmployment, terminateEmployment, } from "./mutations.js";
13
+ export { createCourse, updateCourse, deleteCourse, createForm, updateForm, deleteForm, createContact, deleteContact, createDeal, updateDeal, createKbCollection, updateKbCollection, deleteKbCollection, createKbArticle, updateKbArticle, deleteKbArticle, createChannel, updateChannel, deleteChannel, updateEvent, updateStory, updateDonationCampaign, deleteDonationCampaign, updateTask, deleteTask, updateNote, deleteNote, updateSpace, deleteSpace, createEmployee, updateEmployee, createEmployment, updateEmployment, deleteEmployment, terminateEmployment, createCompensation, updateCompensation, deleteCompensation, } from "./mutations.js";
14
14
  export { getForm, listForms, createFormResponse, updateFormResponse, } from "./forms.js";
15
15
  export type { Form } from "./forms.js";
16
16
  export { getChannel } from "./help-center.js";
@@ -21,12 +21,16 @@ export { getEvent, listEvents, createAttendance, createEvent } from "./events.js
21
21
  export type { Event } from "./events.js";
22
22
  export { getCall, listCalls } from "./calls.js";
23
23
  export type { Call } from "./calls.js";
24
+ export { getJob, listJobs } from "./jobs.js";
25
+ export type { Job } from "./jobs.js";
26
+ export { listApplications, createApplication } from "./applications.js";
27
+ export type { Application } from "./applications.js";
24
28
  export { getDonationCampaign, listDonationCampaigns, createDonation, createDonationCampaign, } from "./donations.js";
25
29
  export type { DonationCampaign } from "./donations.js";
26
30
  export { getStory, listStories, createStory } from "./stories.js";
27
31
  export type { Story } from "./stories.js";
28
32
  export { listEmployees, getEmployee, weekStartFor, listOffices, listCircles, listRoles, listKinds, listCcnls, listEmploymentHistory, contractEvents, } from "./people.js";
29
- export type { Employee, Office, Circle, Kind, EmploymentRecord, EmployeeContracts, ContractEvent, ContractEventType, } from "./people.js";
33
+ export type { Employee, Office, Circle, Kind, EmploymentRecord, CompensationRecord, EmployeeContracts, ContractEvent, ContractEventType, } from "./people.js";
30
34
  export { getBooking, listBookings, getCalendar, listCalendars, getCalendarEvent, listCalendarEvents, } from "./bookings.js";
31
35
  export type { Booking, Calendar, CalendarEvent } from "./bookings.js";
32
36
  export { getCourse, listCourses, getEnrollment, listEnrollments, getLecture, listLectures, } from "./courses.js";
@@ -0,0 +1,15 @@
1
+ import type { UiduClient } from "./client.js";
2
+ import { getCall, listCalls, type Call } from "./calls.js";
3
+ /**
4
+ * A job posting — a {@link Call} whose `kind` is `job`.
5
+ *
6
+ * Jobs are a *derived view* over the `calls` domain: there is no separate
7
+ * `jobs` field in the GraphQL schema, so `listJobs`/`getJob` reuse the calls
8
+ * queries and constrain the result to `kind: job`. No codegen is required for
9
+ * this integration (contrast with `applications`, which is a first-class type).
10
+ */
11
+ export type Job = Call;
12
+ /** List job postings (calls of kind `job`). */
13
+ export declare function listJobs(client: UiduClient, variables?: Parameters<typeof listCalls>[1]): Promise<Awaited<ReturnType<typeof listCalls>>>;
14
+ /** Fetch a single job posting; returns `null` if the call is not a job. */
15
+ export declare function getJob(client: UiduClient, variables: Parameters<typeof getCall>[1]): Promise<Job | null>;
@@ -1,5 +1,5 @@
1
1
  import type { UiduClient } from "./client.js";
2
- import { type CreateChannelMutationVariables, type CreateContactMutationVariables, type CreateCourseMutationVariables, type CreateDealMutationVariables, type CreateEmployeeMutationVariables, type CreateEmploymentMutationVariables, type CreateFormMutationVariables, type CreateKbArticleMutationVariables, type CreateKbCollectionMutationVariables, type DeleteChannelMutationVariables, type DeleteContactMutationVariables, type DeleteCourseMutationVariables, type DeleteDonationCampaignMutationVariables, type DeleteEmploymentMutationVariables, type DeleteFormMutationVariables, type DeleteKbArticleMutationVariables, type DeleteKbCollectionMutationVariables, type DeleteNoteMutationVariables, type DeleteSpaceMutationVariables, type DeleteTaskMutationVariables, type UpdateChannelMutationVariables, 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";
2
+ import { type CreateChannelMutationVariables, type CreateContactMutationVariables, type CreateCourseMutationVariables, type CreateCompensationMutationVariables, type CreateDealMutationVariables, type CreateEmployeeMutationVariables, type CreateEmploymentMutationVariables, type CreateFormMutationVariables, type CreateKbArticleMutationVariables, type CreateKbCollectionMutationVariables, 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
3
  export declare function createCourse(c: UiduClient, v: CreateCourseMutationVariables): Promise<{
4
4
  __typename?: "CreateCoursePayload";
5
5
  course?: {
@@ -257,6 +257,58 @@ export declare function terminateEmployment(c: UiduClient, args: {
257
257
  type: string;
258
258
  }>;
259
259
  } | null>;
260
+ export declare function createCompensation(c: UiduClient, v: CreateCompensationMutationVariables): Promise<{
261
+ __typename?: "CreateCompensationPayload";
262
+ compensation?: {
263
+ __typename?: "CompensationEdge";
264
+ node?: {
265
+ __typename?: "Compensation";
266
+ id: string;
267
+ amount: number;
268
+ currency: string;
269
+ frequency: string;
270
+ componentType: string;
271
+ effectiveFrom: any;
272
+ } | null;
273
+ } | null;
274
+ errors: Array<{
275
+ __typename?: "Error";
276
+ key: string;
277
+ name: string;
278
+ type: string;
279
+ }>;
280
+ } | null>;
281
+ export declare function updateCompensation(c: UiduClient, v: UpdateCompensationMutationVariables): Promise<{
282
+ __typename?: "UpdateCompensationPayload";
283
+ compensation?: {
284
+ __typename?: "Compensation";
285
+ id: string;
286
+ amount: number;
287
+ currency: string;
288
+ frequency: string;
289
+ componentType: string;
290
+ effectiveFrom: any;
291
+ } | null;
292
+ errors: Array<{
293
+ __typename?: "Error";
294
+ key: string;
295
+ name: string;
296
+ type: string;
297
+ }>;
298
+ } | null>;
299
+ export declare function deleteCompensation(c: UiduClient, v: DeleteCompensationMutationVariables): Promise<{
300
+ __typename?: "DeleteCompensationPayload";
301
+ compensation?: {
302
+ __typename?: "Compensation";
303
+ id: string;
304
+ } | null;
305
+ errors: Array<{
306
+ __typename?: "Error";
307
+ key: string;
308
+ name: string;
309
+ type: string;
310
+ }>;
311
+ } | null>;
260
312
  export declare function createKbCollection(c: UiduClient, v: CreateKbCollectionMutationVariables): Promise<{
261
313
  __typename?: "CreateKbCollectionPayload";
262
314
  kbCollection?: {
@@ -51,6 +51,17 @@ export declare function listKinds(client: UiduClient, variables: ListKindsQueryV
51
51
  * workspace — used for an employment's `ccnlId`.
52
52
  */
53
53
  export declare function listCcnls(client: UiduClient, variables?: Omit<ListKindsQueryVariables, 'models'>): Promise<Kind[]>;
54
+ /** A pay item attached to a contract. */
55
+ export type CompensationRecord = {
56
+ id: string;
57
+ amount: number | null;
58
+ currency: string | null;
59
+ /** e.g. monthly, yearly, hourly. */
60
+ frequency: string | null;
61
+ /** e.g. base, bonus. */
62
+ componentType: string | null;
63
+ effectiveFrom: string | null;
64
+ };
54
65
  /** A single contract (employment) reduced to the fields that describe its span. */
55
66
  export type EmploymentRecord = {
56
67
  id: string;
@@ -59,6 +70,13 @@ export type EmploymentRecord = {
59
70
  endReason: string | null;
60
71
  jobTitle: string | null;
61
72
  contractType: string | null;
73
+ /** The CCNL (national collective labor contract) that applies, if any. */
74
+ ccnl: {
75
+ id: string;
76
+ name: string | null;
77
+ } | null;
78
+ /** Pay items on this contract, most recent effective date first. */
79
+ compensations: CompensationRecord[];
62
80
  };
63
81
  /** An employee together with their full list of contracts. */
64
82
  export type EmployeeContracts = {