@rundit-sdk/embed 0.3.6 → 0.3.7-rc.23
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/AGENTS.md +15 -0
- package/README.md +30 -1
- package/ai-manifest.json +125 -9
- package/dist/index.d.ts +156 -19
- package/dist/index.js +131 -9
- package/openapi.json +1375 -62
- package/package.json +1 -1
- package/skills/rundit-sdk-embed/SKILL.md +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -22,6 +22,63 @@ export interface CreateEmbedClientOptions {
|
|
|
22
22
|
headers?: Record<string, string>
|
|
23
23
|
}
|
|
24
24
|
|
|
25
|
+
export interface SdkProfileOptionDto {
|
|
26
|
+
value: string
|
|
27
|
+
label: string
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export interface SdkProfilesConfigDto {
|
|
31
|
+
roles?: SdkProfileOptionDto[]
|
|
32
|
+
positions?: SdkProfileOptionDto[]
|
|
33
|
+
educationLevels?: SdkProfileOptionDto[]
|
|
34
|
+
genders?: SdkProfileOptionDto[]
|
|
35
|
+
races?: SdkProfileOptionDto[]
|
|
36
|
+
nationalities?: SdkProfileOptionDto[]
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface SdkCompanyReferenceDto {
|
|
40
|
+
id: number
|
|
41
|
+
name: string
|
|
42
|
+
type: string | null
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface SdkProfileDto {
|
|
46
|
+
surname: string | null
|
|
47
|
+
email: string | null
|
|
48
|
+
telephone: string | null
|
|
49
|
+
country: string | null
|
|
50
|
+
avatarImageFileUuid: string | null
|
|
51
|
+
expertiseAreas: string | null
|
|
52
|
+
educationLevel: string | null
|
|
53
|
+
linkedIn: string | null
|
|
54
|
+
github: string | null
|
|
55
|
+
website: string | null
|
|
56
|
+
gender: string | null
|
|
57
|
+
birthYear: number | null
|
|
58
|
+
race: string | null
|
|
59
|
+
nationality: string | null
|
|
60
|
+
ethnicity: string | null
|
|
61
|
+
twitter: string | null
|
|
62
|
+
facebook: string | null
|
|
63
|
+
rolesInCompany: ("founder-cofounder" | "management" | "board-member" | "board-chairman")[]
|
|
64
|
+
firstTimeFounder: boolean | null
|
|
65
|
+
position: "chief-executive" | "chief-operating" | "chief-financial" | "chief-information" | "chief-technology" | "chief-marketing" | "chief-human-resources" | "chief-design" | "chief-data" | "chief-product" | "chief-customer" | "chief-revenue" | "chief-sales" | "president" | "vice-president" | "vp-operations" | "vp-finance" | "vp-technology" | "vp-marketing" | "vp-sales" | "vp-human-resources" | "vp-product" | "vp-design" | "vp-customer-support" | "vp-business-development" | "head-operations" | "head-finance" | "head-technology" | "head-marketing" | "head-human-resources" | "head-product" | "head-design" | "head-customer-support" | "head-business-development" | "lead-operations" | "lead-finance" | "lead-technology" | "lead-marketing" | "lead-human-resources" | "lead-product" | "lead-design" | "lead-customer-support" | "lead-business-development" | "chief-mobility-officer" | "evp-business-and-legal-affairs" | "global-general-manager" | "evp-international-co-productions" | "chief-creative-officer" | "executive-chairman" | "chief-experience-n-strategy-officer" | "chief-corporate-officer" | "chief-of-staff" | "chief-people-officer" | "chief-privacy-officer" | "chief-legal-officer" | "svp-people-operations-n-experience" | "svp-marketing" | "svp-product-n-analytics" | "evp-strategic-partnerships" | "svp-of-sales" | "svp-strategic-initiatives" | "head-of-talent" | "head-of-partnerships" | "engineering-manager" | "director-of-customer-success" | "chief-compliance-officer" | "chief-strategy-officer" | "general-counsel" | "vp-engineering" | "director-of-engineering" | "chief-engineer" | "chief-medical-officer" | "executive-editor" | "managing-editor" | "vp-strategy-and-transformation" | "chief-business-officer" | "advisor" | "other"
|
|
66
|
+
id: string
|
|
67
|
+
name: string | null
|
|
68
|
+
companyId: number
|
|
69
|
+
company: SdkCompanyReferenceDto
|
|
70
|
+
avatarImageUrl: string | null
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface SdkPaginationMetaDto {
|
|
74
|
+
nextCursor: string | null
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface SdkProfilesListResponseDto {
|
|
78
|
+
data: SdkProfileDto[]
|
|
79
|
+
meta: SdkPaginationMetaDto
|
|
80
|
+
}
|
|
81
|
+
|
|
25
82
|
export interface SdkCompanyDto {
|
|
26
83
|
id: number
|
|
27
84
|
name: string
|
|
@@ -45,12 +102,6 @@ export interface SdkCompanyDto {
|
|
|
45
102
|
companyGroupIds?: number[]
|
|
46
103
|
}
|
|
47
104
|
|
|
48
|
-
export interface SdkCompanyReferenceDto {
|
|
49
|
-
id: number
|
|
50
|
-
name: string
|
|
51
|
-
type: string | null
|
|
52
|
-
}
|
|
53
|
-
|
|
54
105
|
export interface SdkCompanyGroupReferenceDto {
|
|
55
106
|
id: number
|
|
56
107
|
name: string
|
|
@@ -376,10 +427,6 @@ export interface SdkCompanyDashboardDto {
|
|
|
376
427
|
reports: SdkCompanyReportSummaryDto[]
|
|
377
428
|
}
|
|
378
429
|
|
|
379
|
-
export interface SdkPaginationMetaDto {
|
|
380
|
-
nextCursor: string | null
|
|
381
|
-
}
|
|
382
|
-
|
|
383
430
|
export interface SdkBatchDashboardResponseDto {
|
|
384
431
|
data: SdkCompanyDashboardDto[]
|
|
385
432
|
meta: SdkPaginationMetaDto
|
|
@@ -804,6 +851,12 @@ export interface SdkCompanyReportDto {
|
|
|
804
851
|
attachments: SdkCompanyReportAttachmentDto[]
|
|
805
852
|
}
|
|
806
853
|
|
|
854
|
+
export type ProfilesGetConfigResponse = SdkProfilesConfigDto
|
|
855
|
+
|
|
856
|
+
export type ProfilesListResponse = SdkProfilesListResponseDto
|
|
857
|
+
|
|
858
|
+
export type ProfilesGetOneResponse = SdkProfileDto
|
|
859
|
+
|
|
807
860
|
export type CompaniesGetDashboardsResponse = SdkBatchDashboardResponseDto
|
|
808
861
|
|
|
809
862
|
export type CompaniesGetDashboardsBody = GetBatchDashboardBodyDto
|
|
@@ -848,6 +901,60 @@ export type CompanyReportsListResponse = SdkCompanyReportsListResponseDto
|
|
|
848
901
|
|
|
849
902
|
export type CompanyReportsGetOneResponse = SdkCompanyReportDto
|
|
850
903
|
|
|
904
|
+
export interface ProfilesGetConfigQuery {
|
|
905
|
+
/**
|
|
906
|
+
* Return only these reference-data sections. Omit or pass [] for the complete config.
|
|
907
|
+
*/
|
|
908
|
+
sections?: ("roles" | "positions" | "educationLevels" | "genders" | "races" | "nationalities")[]
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
export interface ProfilesListQuery {
|
|
912
|
+
/**
|
|
913
|
+
* Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested.
|
|
914
|
+
*/
|
|
915
|
+
limit?: number
|
|
916
|
+
/**
|
|
917
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
918
|
+
*/
|
|
919
|
+
cursor?: string
|
|
920
|
+
/**
|
|
921
|
+
* Filter founders by a recorded Yes/No answer. false does not match unknown answers or non-founders.
|
|
922
|
+
*/
|
|
923
|
+
firstTimeFounder?: boolean
|
|
924
|
+
/**
|
|
925
|
+
* Filter by a company position from profiles.getConfig.
|
|
926
|
+
*/
|
|
927
|
+
position?: "chief-executive" | "chief-operating" | "chief-financial" | "chief-information" | "chief-technology" | "chief-marketing" | "chief-human-resources" | "chief-design" | "chief-data" | "chief-product" | "chief-customer" | "chief-revenue" | "chief-sales" | "president" | "vice-president" | "vp-operations" | "vp-finance" | "vp-technology" | "vp-marketing" | "vp-sales" | "vp-human-resources" | "vp-product" | "vp-design" | "vp-customer-support" | "vp-business-development" | "head-operations" | "head-finance" | "head-technology" | "head-marketing" | "head-human-resources" | "head-product" | "head-design" | "head-customer-support" | "head-business-development" | "lead-operations" | "lead-finance" | "lead-technology" | "lead-marketing" | "lead-human-resources" | "lead-product" | "lead-design" | "lead-customer-support" | "lead-business-development" | "chief-mobility-officer" | "evp-business-and-legal-affairs" | "global-general-manager" | "evp-international-co-productions" | "chief-creative-officer" | "executive-chairman" | "chief-experience-n-strategy-officer" | "chief-corporate-officer" | "chief-of-staff" | "chief-people-officer" | "chief-privacy-officer" | "chief-legal-officer" | "svp-people-operations-n-experience" | "svp-marketing" | "svp-product-n-analytics" | "evp-strategic-partnerships" | "svp-of-sales" | "svp-strategic-initiatives" | "head-of-talent" | "head-of-partnerships" | "engineering-manager" | "director-of-customer-success" | "chief-compliance-officer" | "chief-strategy-officer" | "general-counsel" | "vp-engineering" | "director-of-engineering" | "chief-engineer" | "chief-medical-officer" | "executive-editor" | "managing-editor" | "vp-strategy-and-transformation" | "chief-business-officer" | "advisor" | "other"
|
|
928
|
+
/**
|
|
929
|
+
* Match any of these positions (OR). Intersects with other filters, including scalar position when supplied.
|
|
930
|
+
*/
|
|
931
|
+
positions?: ("chief-executive" | "chief-operating" | "chief-financial" | "chief-information" | "chief-technology" | "chief-marketing" | "chief-human-resources" | "chief-design" | "chief-data" | "chief-product" | "chief-customer" | "chief-revenue" | "chief-sales" | "president" | "vice-president" | "vp-operations" | "vp-finance" | "vp-technology" | "vp-marketing" | "vp-sales" | "vp-human-resources" | "vp-product" | "vp-design" | "vp-customer-support" | "vp-business-development" | "head-operations" | "head-finance" | "head-technology" | "head-marketing" | "head-human-resources" | "head-product" | "head-design" | "head-customer-support" | "head-business-development" | "lead-operations" | "lead-finance" | "lead-technology" | "lead-marketing" | "lead-human-resources" | "lead-product" | "lead-design" | "lead-customer-support" | "lead-business-development" | "chief-mobility-officer" | "evp-business-and-legal-affairs" | "global-general-manager" | "evp-international-co-productions" | "chief-creative-officer" | "executive-chairman" | "chief-experience-n-strategy-officer" | "chief-corporate-officer" | "chief-of-staff" | "chief-people-officer" | "chief-privacy-officer" | "chief-legal-officer" | "svp-people-operations-n-experience" | "svp-marketing" | "svp-product-n-analytics" | "evp-strategic-partnerships" | "svp-of-sales" | "svp-strategic-initiatives" | "head-of-talent" | "head-of-partnerships" | "engineering-manager" | "director-of-customer-success" | "chief-compliance-officer" | "chief-strategy-officer" | "general-counsel" | "vp-engineering" | "director-of-engineering" | "chief-engineer" | "chief-medical-officer" | "executive-editor" | "managing-editor" | "vp-strategy-and-transformation" | "chief-business-officer" | "advisor" | "other")[]
|
|
932
|
+
companyIds?: number[]
|
|
933
|
+
/**
|
|
934
|
+
* Restrict to companies in these funds
|
|
935
|
+
*/
|
|
936
|
+
companyGroupIds?: number[]
|
|
937
|
+
/**
|
|
938
|
+
* Case-insensitive company name substrings (OR)
|
|
939
|
+
*/
|
|
940
|
+
companyNameSearch?: string[]
|
|
941
|
+
/**
|
|
942
|
+
* Case-insensitive person full-name substrings (OR)
|
|
943
|
+
*/
|
|
944
|
+
nameSearch?: string[]
|
|
945
|
+
/**
|
|
946
|
+
* Match any of these recorded roles; omitted returns the whole directory
|
|
947
|
+
*/
|
|
948
|
+
rolesInCompany?: ("founder-cofounder" | "management" | "board-member" | "board-chairman")[]
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
export interface ProfilesGetOneQuery {
|
|
952
|
+
/**
|
|
953
|
+
* Company context for this directory entry. Must match an existing association; profiles cannot be moved to another company.
|
|
954
|
+
*/
|
|
955
|
+
companyId: number
|
|
956
|
+
}
|
|
957
|
+
|
|
851
958
|
export interface CompaniesGetDashboardQuery {
|
|
852
959
|
/**
|
|
853
960
|
* Reporting currency code (ISO 4217).
|
|
@@ -897,7 +1004,7 @@ export interface CompaniesGetAllQuery {
|
|
|
897
1004
|
*/
|
|
898
1005
|
limit?: number
|
|
899
1006
|
/**
|
|
900
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1007
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
901
1008
|
*/
|
|
902
1009
|
cursor?: string
|
|
903
1010
|
/**
|
|
@@ -920,7 +1027,7 @@ export interface CompanyGroupsGetAllQuery {
|
|
|
920
1027
|
*/
|
|
921
1028
|
limit?: number
|
|
922
1029
|
/**
|
|
923
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1030
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
924
1031
|
*/
|
|
925
1032
|
cursor?: string
|
|
926
1033
|
/**
|
|
@@ -939,7 +1046,7 @@ export interface PositionsGetPortfolioSummaryQuery {
|
|
|
939
1046
|
*/
|
|
940
1047
|
limit?: number
|
|
941
1048
|
/**
|
|
942
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1049
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
943
1050
|
*/
|
|
944
1051
|
cursor?: string
|
|
945
1052
|
/**
|
|
@@ -983,7 +1090,7 @@ export interface PositionsGetCompanyPositionsQuery {
|
|
|
983
1090
|
*/
|
|
984
1091
|
limit?: number
|
|
985
1092
|
/**
|
|
986
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1093
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
987
1094
|
*/
|
|
988
1095
|
cursor?: string
|
|
989
1096
|
/**
|
|
@@ -1025,7 +1132,7 @@ export interface TransactionsGetSummaryQuery {
|
|
|
1025
1132
|
*/
|
|
1026
1133
|
limit?: number
|
|
1027
1134
|
/**
|
|
1028
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1135
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1029
1136
|
*/
|
|
1030
1137
|
cursor?: string
|
|
1031
1138
|
/**
|
|
@@ -1060,7 +1167,7 @@ export interface TransactionsGetCompanyTransactionsQuery {
|
|
|
1060
1167
|
*/
|
|
1061
1168
|
limit?: number
|
|
1062
1169
|
/**
|
|
1063
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1170
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1064
1171
|
*/
|
|
1065
1172
|
cursor?: string
|
|
1066
1173
|
/**
|
|
@@ -1083,7 +1190,7 @@ export interface TransactionsGetTransactionsQuery {
|
|
|
1083
1190
|
*/
|
|
1084
1191
|
limit?: number
|
|
1085
1192
|
/**
|
|
1086
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1193
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1087
1194
|
*/
|
|
1088
1195
|
cursor?: string
|
|
1089
1196
|
/**
|
|
@@ -1110,7 +1217,7 @@ export interface MetricsGetTypesQuery {
|
|
|
1110
1217
|
*/
|
|
1111
1218
|
limit?: number
|
|
1112
1219
|
/**
|
|
1113
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1220
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1114
1221
|
*/
|
|
1115
1222
|
cursor?: string
|
|
1116
1223
|
origin?: "Predefined" | "UserDefined"
|
|
@@ -1126,7 +1233,7 @@ export interface CompanyReportsListQuery {
|
|
|
1126
1233
|
*/
|
|
1127
1234
|
limit?: number
|
|
1128
1235
|
/**
|
|
1129
|
-
* Opaque cursor from a previous response's `meta.nextCursor`.
|
|
1236
|
+
* Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions.
|
|
1130
1237
|
*/
|
|
1131
1238
|
cursor?: string
|
|
1132
1239
|
/**
|
|
@@ -1159,6 +1266,30 @@ export interface CompanyReportsListQuery {
|
|
|
1159
1266
|
to?: string
|
|
1160
1267
|
}
|
|
1161
1268
|
|
|
1269
|
+
export interface ProfilesNamespace {
|
|
1270
|
+
/**
|
|
1271
|
+
* Get allowed profile field values and labels
|
|
1272
|
+
* Reference data for directory CRUD: roles, positions, education levels, genders, races and nationalities. Use sections to request only what you need (e.g. ["roles","positions"]); omitted or [] returns the complete config. Contains no customer profiles. Use the option value, not its label, when writing.
|
|
1273
|
+
* Parameters: query: sections? (("roles" | "positions" | "educationLevels" | "genders" | "races" | "nationalities")[])
|
|
1274
|
+
* Returns: ProfilesGetConfigResponse
|
|
1275
|
+
*/
|
|
1276
|
+
getConfig(query?: ProfilesGetConfigQuery, init?: RequestOptions): Promise<ProfilesGetConfigResponse>
|
|
1277
|
+
/**
|
|
1278
|
+
* List the founders, management and board directory
|
|
1279
|
+
* Returns full profile fields for accessible companies, one entry per profile and company. Filter by company ids, funds, company name, person name, recorded roles, firstTimeFounder, position or positions (OR within the array). Filters intersect. firstTimeFounder=false matches recorded No answers only, not unknown answers or non-founders. Omitted roles returns the whole directory. Absence of a role means not recorded, not a verified negative. First-time-founder null means Not specified. Ordered by company id then profile UUID; repeat the original filters when passing the next cursor. Existing legacy free-text values remain readable; format validation applies to supplied write fields.
|
|
1280
|
+
* Parameters: query: limit? (number), cursor? (string), firstTimeFounder? (boolean), position? ("chief-executive" | "chief-operating" | "chief-financial" | "chief-information" | "chief-technology" | "chief-marketing" | "chief-human-resources" | "chief-design" | "chief-data" | "chief-product" | "chief-customer" | "chief-revenue" | "chief-sales" | "president" | "vice-president" | "vp-operations" | "vp-finance" | "vp-technology" | "vp-marketing" | "vp-sales" | "vp-human-resources" | "vp-product" | "vp-design" | "vp-customer-support" | "vp-business-development" | "head-operations" | "head-finance" | "head-technology" | "head-marketing" | "head-human-resources" | "head-product" | "head-design" | "head-customer-support" | "head-business-development" | "lead-operations" | "lead-finance" | "lead-technology" | "lead-marketing" | "lead-human-resources" | "lead-product" | "lead-design" | "lead-customer-support" | "lead-business-development" | "chief-mobility-officer" | "evp-business-and-legal-affairs" | "global-general-manager" | "evp-international-co-productions" | "chief-creative-officer" | "executive-chairman" | "chief-experience-n-strategy-officer" | "chief-corporate-officer" | "chief-of-staff" | "chief-people-officer" | "chief-privacy-officer" | "chief-legal-officer" | "svp-people-operations-n-experience" | "svp-marketing" | "svp-product-n-analytics" | "evp-strategic-partnerships" | "svp-of-sales" | "svp-strategic-initiatives" | "head-of-talent" | "head-of-partnerships" | "engineering-manager" | "director-of-customer-success" | "chief-compliance-officer" | "chief-strategy-officer" | "general-counsel" | "vp-engineering" | "director-of-engineering" | "chief-engineer" | "chief-medical-officer" | "executive-editor" | "managing-editor" | "vp-strategy-and-transformation" | "chief-business-officer" | "advisor" | "other"), positions? (("chief-executive" | "chief-operating" | "chief-financial" | "chief-information" | "chief-technology" | "chief-marketing" | "chief-human-resources" | "chief-design" | "chief-data" | "chief-product" | "chief-customer" | "chief-revenue" | "chief-sales" | "president" | "vice-president" | "vp-operations" | "vp-finance" | "vp-technology" | "vp-marketing" | "vp-sales" | "vp-human-resources" | "vp-product" | "vp-design" | "vp-customer-support" | "vp-business-development" | "head-operations" | "head-finance" | "head-technology" | "head-marketing" | "head-human-resources" | "head-product" | "head-design" | "head-customer-support" | "head-business-development" | "lead-operations" | "lead-finance" | "lead-technology" | "lead-marketing" | "lead-human-resources" | "lead-product" | "lead-design" | "lead-customer-support" | "lead-business-development" | "chief-mobility-officer" | "evp-business-and-legal-affairs" | "global-general-manager" | "evp-international-co-productions" | "chief-creative-officer" | "executive-chairman" | "chief-experience-n-strategy-officer" | "chief-corporate-officer" | "chief-of-staff" | "chief-people-officer" | "chief-privacy-officer" | "chief-legal-officer" | "svp-people-operations-n-experience" | "svp-marketing" | "svp-product-n-analytics" | "evp-strategic-partnerships" | "svp-of-sales" | "svp-strategic-initiatives" | "head-of-talent" | "head-of-partnerships" | "engineering-manager" | "director-of-customer-success" | "chief-compliance-officer" | "chief-strategy-officer" | "general-counsel" | "vp-engineering" | "director-of-engineering" | "chief-engineer" | "chief-medical-officer" | "executive-editor" | "managing-editor" | "vp-strategy-and-transformation" | "chief-business-officer" | "advisor" | "other")[]), companyIds? (number[]), companyGroupIds? (number[]), companyNameSearch? (string[]), nameSearch? (string[]), rolesInCompany? (("founder-cofounder" | "management" | "board-member" | "board-chairman")[])
|
|
1281
|
+
* Returns: ProfilesListResponse
|
|
1282
|
+
*/
|
|
1283
|
+
list(query?: ProfilesListQuery, init?: RequestOptions): Promise<ProfilesListResponse>
|
|
1284
|
+
/**
|
|
1285
|
+
* Get a full directory profile
|
|
1286
|
+
* Requires the profile UUID and companyId from a directory entry. Returns all fields in that company context without disclosing other company associations.
|
|
1287
|
+
* Parameters: path: id (string); query: companyId (number)
|
|
1288
|
+
* Returns: ProfilesGetOneResponse
|
|
1289
|
+
*/
|
|
1290
|
+
getOne(id: string, query?: ProfilesGetOneQuery, init?: RequestOptions): Promise<ProfilesGetOneResponse>
|
|
1291
|
+
}
|
|
1292
|
+
|
|
1162
1293
|
export interface CompaniesNamespace {
|
|
1163
1294
|
/**
|
|
1164
1295
|
* PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
|
|
@@ -1304,6 +1435,7 @@ export interface CompanyReportsNamespace {
|
|
|
1304
1435
|
}
|
|
1305
1436
|
|
|
1306
1437
|
export interface EmbedClient {
|
|
1438
|
+
profiles: ProfilesNamespace
|
|
1307
1439
|
companies: CompaniesNamespace
|
|
1308
1440
|
companyGroups: CompanyGroupsNamespace
|
|
1309
1441
|
positions: PositionsNamespace
|
|
@@ -1315,6 +1447,11 @@ export interface EmbedClient {
|
|
|
1315
1447
|
export declare function createEmbedClient(options: CreateEmbedClientOptions): EmbedClient
|
|
1316
1448
|
|
|
1317
1449
|
export declare const routeManifest: {
|
|
1450
|
+
profiles: {
|
|
1451
|
+
getConfig: { method: "GET"; path: "/profiles/config"; summary: "Get allowed profile field values and labels"; description: "Reference data for directory CRUD: roles, positions, education levels, genders, races and nationalities. Use sections to request only what you need (e.g. [\"roles\",\"positions\"]); omitted or [] returns the complete config. Contains no customer profiles. Use the option value, not its label, when writing."; exampleCall: "client.profiles.getConfig({ sections: ['example'] })"; responseType: "ProfilesGetConfigResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1452
|
+
list: { method: "GET"; path: "/profiles"; summary: "List the founders, management and board directory"; description: "Returns full profile fields for accessible companies, one entry per profile and company. Filter by company ids, funds, company name, person name, recorded roles, firstTimeFounder, position or positions (OR within the array). Filters intersect. firstTimeFounder=false matches recorded No answers only, not unknown answers or non-founders. Omitted roles returns the whole directory. Absence of a role means not recorded, not a verified negative. First-time-founder null means Not specified. Ordered by company id then profile UUID; repeat the original filters when passing the next cursor. Existing legacy free-text values remain readable; format validation applies to supplied write fields."; exampleCall: "client.profiles.list({ limit: 123 })"; responseType: "ProfilesListResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1453
|
+
getOne: { method: "GET"; path: "/profiles/:id"; summary: "Get a full directory profile"; description: "Requires the profile UUID and companyId from a directory entry. Returns all fields in that company context without disclosing other company associations."; exampleCall: "client.profiles.getOne('123', { companyId: 123 })"; responseType: "ProfilesGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1454
|
+
}
|
|
1318
1455
|
companies: {
|
|
1319
1456
|
getDashboards: { method: "POST"; path: "/companies/dashboards"; summary: "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call"; description: "PREFERRED tool for multi-company analysis. Returns full dashboards (company metadata, positions, metrics with data points, recent transactions, report summaries) for many companies in a single request, grouped per company. Use this instead of looping `GET /companies/:id/dashboard` (the N+1 pattern) whenever the agent needs to look at more than one company — it returns the same shape per company but in one round trip. Typical workflow: resolve company ids (e.g. `GET /companies?nameSearch=[\"acme\",\"beta\"]`), then call this with their `companyIds`. Use `metricTypeIds` or `metricTypeNames` (case-insensitive exact match on full name or `shortName`) to scope the returned metrics. `metricsFrom` (ISO 8601) sets a lower-bound date for metric data points; omit to include all history. `metricsTimeframe` restricts data point granularity to Month, Quarter, or Year. `metricsPointLimit` keeps only the most recent N points per metric (`1` = latest dated point; set `metricsTo` to today to exclude future values) — full histories for many companies add up quickly. `currency` (ISO 4217, required) FX-converts all monetary metrics across the batch. `conversionStrategy` controls which rate is applied: `LATEST_FX_RATE` (default) or `ENTITY_DATE_RATE` (the rate on each point's own date). `transactionLimit` / `reportLimit` cap list sizes per company (defaults: 10 and 5 respectively). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable."; exampleCall: "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })"; responseType: "CompaniesGetDashboardsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1320
1457
|
getDashboard: { method: "GET"; path: "/companies/:id/dashboard"; summary: "Get full company dashboard for ONE company"; description: "Returns company metadata, positions per fund, metrics with data points, recent transactions, and report summaries for a single company. For more than one company, prefer POST /companies/dashboards (`companies.getDashboards`) instead — it returns the same payload per company in one call and avoids the N+1 pattern. Takes the same metric options as the batch route: `metricTypeNames` / `metricTypeIds` scope which metrics are included, `metricsTimeframe` picks a granularity, `metricsFrom`, `metricsTo`, and `metricsPointLimit` limit history (`metricsPointLimit: 1` = latest dated point; set `metricsTo` to today for current values — prefer it over `metricsFrom` for \"latest\" reads, since a date lower bound hides values last reported before it). `transactionLimit` and `reportLimit` cap list sizes."; exampleCall: "client.companies.getDashboard(123, { currency: 'USD' })"; responseType: "CompaniesGetDashboardResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,117 @@
|
|
|
1
1
|
const routeManifest = {
|
|
2
|
+
"profiles": {
|
|
3
|
+
"getConfig": {
|
|
4
|
+
"method": "GET",
|
|
5
|
+
"path": "/profiles/config",
|
|
6
|
+
"summary": "Get allowed profile field values and labels",
|
|
7
|
+
"description": "Reference data for directory CRUD: roles, positions, education levels, genders, races and nationalities. Use sections to request only what you need (e.g. [\"roles\",\"positions\"]); omitted or [] returns the complete config. Contains no customer profiles. Use the option value, not its label, when writing.",
|
|
8
|
+
"exampleCall": "client.profiles.getConfig({ sections: ['example'] })",
|
|
9
|
+
"responseType": "ProfilesGetConfigResponse",
|
|
10
|
+
"pathParams": [],
|
|
11
|
+
"queryParams": [
|
|
12
|
+
{
|
|
13
|
+
"name": "sections",
|
|
14
|
+
"required": false,
|
|
15
|
+
"type": "(\"roles\" | \"positions\" | \"educationLevels\" | \"genders\" | \"races\" | \"nationalities\")[]",
|
|
16
|
+
"description": "Return only these reference-data sections. Omit or pass [] for the complete config."
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
"list": {
|
|
21
|
+
"method": "GET",
|
|
22
|
+
"path": "/profiles",
|
|
23
|
+
"summary": "List the founders, management and board directory",
|
|
24
|
+
"description": "Returns full profile fields for accessible companies, one entry per profile and company. Filter by company ids, funds, company name, person name, recorded roles, firstTimeFounder, position or positions (OR within the array). Filters intersect. firstTimeFounder=false matches recorded No answers only, not unknown answers or non-founders. Omitted roles returns the whole directory. Absence of a role means not recorded, not a verified negative. First-time-founder null means Not specified. Ordered by company id then profile UUID; repeat the original filters when passing the next cursor. Existing legacy free-text values remain readable; format validation applies to supplied write fields.",
|
|
25
|
+
"exampleCall": "client.profiles.list({ limit: 123 })",
|
|
26
|
+
"responseType": "ProfilesListResponse",
|
|
27
|
+
"pathParams": [],
|
|
28
|
+
"queryParams": [
|
|
29
|
+
{
|
|
30
|
+
"name": "limit",
|
|
31
|
+
"required": false,
|
|
32
|
+
"type": "number",
|
|
33
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "cursor",
|
|
37
|
+
"required": false,
|
|
38
|
+
"type": "string",
|
|
39
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "firstTimeFounder",
|
|
43
|
+
"required": false,
|
|
44
|
+
"type": "boolean",
|
|
45
|
+
"description": "Filter founders by a recorded Yes/No answer. false does not match unknown answers or non-founders."
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "position",
|
|
49
|
+
"required": false,
|
|
50
|
+
"type": "\"chief-executive\" | \"chief-operating\" | \"chief-financial\" | \"chief-information\" | \"chief-technology\" | \"chief-marketing\" | \"chief-human-resources\" | \"chief-design\" | \"chief-data\" | \"chief-product\" | \"chief-customer\" | \"chief-revenue\" | \"chief-sales\" | \"president\" | \"vice-president\" | \"vp-operations\" | \"vp-finance\" | \"vp-technology\" | \"vp-marketing\" | \"vp-sales\" | \"vp-human-resources\" | \"vp-product\" | \"vp-design\" | \"vp-customer-support\" | \"vp-business-development\" | \"head-operations\" | \"head-finance\" | \"head-technology\" | \"head-marketing\" | \"head-human-resources\" | \"head-product\" | \"head-design\" | \"head-customer-support\" | \"head-business-development\" | \"lead-operations\" | \"lead-finance\" | \"lead-technology\" | \"lead-marketing\" | \"lead-human-resources\" | \"lead-product\" | \"lead-design\" | \"lead-customer-support\" | \"lead-business-development\" | \"chief-mobility-officer\" | \"evp-business-and-legal-affairs\" | \"global-general-manager\" | \"evp-international-co-productions\" | \"chief-creative-officer\" | \"executive-chairman\" | \"chief-experience-n-strategy-officer\" | \"chief-corporate-officer\" | \"chief-of-staff\" | \"chief-people-officer\" | \"chief-privacy-officer\" | \"chief-legal-officer\" | \"svp-people-operations-n-experience\" | \"svp-marketing\" | \"svp-product-n-analytics\" | \"evp-strategic-partnerships\" | \"svp-of-sales\" | \"svp-strategic-initiatives\" | \"head-of-talent\" | \"head-of-partnerships\" | \"engineering-manager\" | \"director-of-customer-success\" | \"chief-compliance-officer\" | \"chief-strategy-officer\" | \"general-counsel\" | \"vp-engineering\" | \"director-of-engineering\" | \"chief-engineer\" | \"chief-medical-officer\" | \"executive-editor\" | \"managing-editor\" | \"vp-strategy-and-transformation\" | \"chief-business-officer\" | \"advisor\" | \"other\"",
|
|
51
|
+
"description": "Filter by a company position from profiles.getConfig."
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "positions",
|
|
55
|
+
"required": false,
|
|
56
|
+
"type": "(\"chief-executive\" | \"chief-operating\" | \"chief-financial\" | \"chief-information\" | \"chief-technology\" | \"chief-marketing\" | \"chief-human-resources\" | \"chief-design\" | \"chief-data\" | \"chief-product\" | \"chief-customer\" | \"chief-revenue\" | \"chief-sales\" | \"president\" | \"vice-president\" | \"vp-operations\" | \"vp-finance\" | \"vp-technology\" | \"vp-marketing\" | \"vp-sales\" | \"vp-human-resources\" | \"vp-product\" | \"vp-design\" | \"vp-customer-support\" | \"vp-business-development\" | \"head-operations\" | \"head-finance\" | \"head-technology\" | \"head-marketing\" | \"head-human-resources\" | \"head-product\" | \"head-design\" | \"head-customer-support\" | \"head-business-development\" | \"lead-operations\" | \"lead-finance\" | \"lead-technology\" | \"lead-marketing\" | \"lead-human-resources\" | \"lead-product\" | \"lead-design\" | \"lead-customer-support\" | \"lead-business-development\" | \"chief-mobility-officer\" | \"evp-business-and-legal-affairs\" | \"global-general-manager\" | \"evp-international-co-productions\" | \"chief-creative-officer\" | \"executive-chairman\" | \"chief-experience-n-strategy-officer\" | \"chief-corporate-officer\" | \"chief-of-staff\" | \"chief-people-officer\" | \"chief-privacy-officer\" | \"chief-legal-officer\" | \"svp-people-operations-n-experience\" | \"svp-marketing\" | \"svp-product-n-analytics\" | \"evp-strategic-partnerships\" | \"svp-of-sales\" | \"svp-strategic-initiatives\" | \"head-of-talent\" | \"head-of-partnerships\" | \"engineering-manager\" | \"director-of-customer-success\" | \"chief-compliance-officer\" | \"chief-strategy-officer\" | \"general-counsel\" | \"vp-engineering\" | \"director-of-engineering\" | \"chief-engineer\" | \"chief-medical-officer\" | \"executive-editor\" | \"managing-editor\" | \"vp-strategy-and-transformation\" | \"chief-business-officer\" | \"advisor\" | \"other\")[]",
|
|
57
|
+
"description": "Match any of these positions (OR). Intersects with other filters, including scalar position when supplied."
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "companyIds",
|
|
61
|
+
"required": false,
|
|
62
|
+
"type": "number[]",
|
|
63
|
+
"description": null
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"name": "companyGroupIds",
|
|
67
|
+
"required": false,
|
|
68
|
+
"type": "number[]",
|
|
69
|
+
"description": "Restrict to companies in these funds"
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "companyNameSearch",
|
|
73
|
+
"required": false,
|
|
74
|
+
"type": "string[]",
|
|
75
|
+
"description": "Case-insensitive company name substrings (OR)"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "nameSearch",
|
|
79
|
+
"required": false,
|
|
80
|
+
"type": "string[]",
|
|
81
|
+
"description": "Case-insensitive person full-name substrings (OR)"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "rolesInCompany",
|
|
85
|
+
"required": false,
|
|
86
|
+
"type": "(\"founder-cofounder\" | \"management\" | \"board-member\" | \"board-chairman\")[]",
|
|
87
|
+
"description": "Match any of these recorded roles; omitted returns the whole directory"
|
|
88
|
+
}
|
|
89
|
+
]
|
|
90
|
+
},
|
|
91
|
+
"getOne": {
|
|
92
|
+
"method": "GET",
|
|
93
|
+
"path": "/profiles/:id",
|
|
94
|
+
"summary": "Get a full directory profile",
|
|
95
|
+
"description": "Requires the profile UUID and companyId from a directory entry. Returns all fields in that company context without disclosing other company associations.",
|
|
96
|
+
"exampleCall": "client.profiles.getOne('123', { companyId: 123 })",
|
|
97
|
+
"responseType": "ProfilesGetOneResponse",
|
|
98
|
+
"pathParams": [
|
|
99
|
+
{
|
|
100
|
+
"name": "id",
|
|
101
|
+
"type": "string",
|
|
102
|
+
"description": null
|
|
103
|
+
}
|
|
104
|
+
],
|
|
105
|
+
"queryParams": [
|
|
106
|
+
{
|
|
107
|
+
"name": "companyId",
|
|
108
|
+
"required": true,
|
|
109
|
+
"type": "number",
|
|
110
|
+
"description": "Company context for this directory entry. Must match an existing association; profiles cannot be moved to another company."
|
|
111
|
+
}
|
|
112
|
+
]
|
|
113
|
+
}
|
|
114
|
+
},
|
|
2
115
|
"companies": {
|
|
3
116
|
"getDashboards": {
|
|
4
117
|
"method": "POST",
|
|
@@ -122,7 +235,7 @@ const routeManifest = {
|
|
|
122
235
|
"name": "cursor",
|
|
123
236
|
"required": false,
|
|
124
237
|
"type": "string",
|
|
125
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
238
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
126
239
|
},
|
|
127
240
|
{
|
|
128
241
|
"name": "companyIds",
|
|
@@ -165,7 +278,7 @@ const routeManifest = {
|
|
|
165
278
|
"name": "cursor",
|
|
166
279
|
"required": false,
|
|
167
280
|
"type": "string",
|
|
168
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
281
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
169
282
|
},
|
|
170
283
|
{
|
|
171
284
|
"name": "companyGroupIds",
|
|
@@ -218,7 +331,7 @@ const routeManifest = {
|
|
|
218
331
|
"name": "cursor",
|
|
219
332
|
"required": false,
|
|
220
333
|
"type": "string",
|
|
221
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
334
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
222
335
|
},
|
|
223
336
|
{
|
|
224
337
|
"name": "groupBy",
|
|
@@ -301,7 +414,7 @@ const routeManifest = {
|
|
|
301
414
|
"name": "cursor",
|
|
302
415
|
"required": false,
|
|
303
416
|
"type": "string",
|
|
304
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
417
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
305
418
|
},
|
|
306
419
|
{
|
|
307
420
|
"name": "companyGroupIds",
|
|
@@ -379,7 +492,7 @@ const routeManifest = {
|
|
|
379
492
|
"name": "cursor",
|
|
380
493
|
"required": false,
|
|
381
494
|
"type": "string",
|
|
382
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
495
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
383
496
|
},
|
|
384
497
|
{
|
|
385
498
|
"name": "companyGroupIds",
|
|
@@ -444,7 +557,7 @@ const routeManifest = {
|
|
|
444
557
|
"name": "cursor",
|
|
445
558
|
"required": false,
|
|
446
559
|
"type": "string",
|
|
447
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
560
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
448
561
|
},
|
|
449
562
|
{
|
|
450
563
|
"name": "companyGroupIds",
|
|
@@ -485,7 +598,7 @@ const routeManifest = {
|
|
|
485
598
|
"name": "cursor",
|
|
486
599
|
"required": false,
|
|
487
600
|
"type": "string",
|
|
488
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
601
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
489
602
|
},
|
|
490
603
|
{
|
|
491
604
|
"name": "companyGroupIds",
|
|
@@ -534,7 +647,7 @@ const routeManifest = {
|
|
|
534
647
|
"name": "cursor",
|
|
535
648
|
"required": false,
|
|
536
649
|
"type": "string",
|
|
537
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
650
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
538
651
|
},
|
|
539
652
|
{
|
|
540
653
|
"name": "origin",
|
|
@@ -601,7 +714,7 @@ const routeManifest = {
|
|
|
601
714
|
"name": "cursor",
|
|
602
715
|
"required": false,
|
|
603
716
|
"type": "string",
|
|
604
|
-
"description": "Opaque cursor from a previous response's `meta.nextCursor`.
|
|
717
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Repeat the original filters and pass nextCursor as cursor; limit can be omitted because the cursor carries its page size. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
605
718
|
},
|
|
606
719
|
{
|
|
607
720
|
"name": "sortBy",
|
|
@@ -787,6 +900,14 @@ function createRequester(options) {
|
|
|
787
900
|
}
|
|
788
901
|
}
|
|
789
902
|
|
|
903
|
+
function createProfilesNamespace(request) {
|
|
904
|
+
return {
|
|
905
|
+
getConfig: (query = {}, init = {}) => request({ method: "GET", path: "/profiles/config", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
906
|
+
list: (query = {}, init = {}) => request({ method: "GET", path: "/profiles", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
|
|
907
|
+
getOne: (id, query = {}, init = {}) => request({ method: "GET", path: "/profiles/:id", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
|
|
790
911
|
function createCompaniesNamespace(request) {
|
|
791
912
|
return {
|
|
792
913
|
getDashboards: (body, init = {}) => request({ method: "POST", path: "/companies/dashboards", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
|
|
@@ -847,6 +968,7 @@ export function createEmbedClient(options) {
|
|
|
847
968
|
const request = createRequester(options)
|
|
848
969
|
|
|
849
970
|
return {
|
|
971
|
+
profiles: createProfilesNamespace(request),
|
|
850
972
|
companies: createCompaniesNamespace(request),
|
|
851
973
|
companyGroups: createCompanyGroupsNamespace(request),
|
|
852
974
|
positions: createPositionsNamespace(request),
|