@vibexp/api-client 0.80.0 → 0.82.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/dist/axios/index.d.ts +2 -2
- package/dist/axios/index.js +1 -1
- package/dist/axios/sdk.gen.d.ts +101 -1
- package/dist/axios/sdk.gen.js +178 -0
- package/dist/axios/types.gen.d.ts +503 -27
- package/dist/schema.d.ts +775 -37
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -2806,6 +2806,184 @@ export interface paths {
|
|
|
2806
2806
|
patch?: never;
|
|
2807
2807
|
trace?: never;
|
|
2808
2808
|
};
|
|
2809
|
+
"/api/v1/admin/users/{id}/insights": {
|
|
2810
|
+
parameters: {
|
|
2811
|
+
query?: never;
|
|
2812
|
+
header?: never;
|
|
2813
|
+
path?: never;
|
|
2814
|
+
cookie?: never;
|
|
2815
|
+
};
|
|
2816
|
+
/**
|
|
2817
|
+
* Get a user's resource counts
|
|
2818
|
+
* @description Returns how many resources of each of the nine counted types (prompts,
|
|
2819
|
+
* memories, artifacts, blueprints, agents, feeds, feed items, comments,
|
|
2820
|
+
* attachments) the user authored: instance-wide totals, per team, and per
|
|
2821
|
+
* project for the four project-scoped types. Counts only — no titles, slugs or
|
|
2822
|
+
* content.
|
|
2823
|
+
*
|
|
2824
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2825
|
+
* does an unknown user id.
|
|
2826
|
+
*/
|
|
2827
|
+
get: operations["getAdminUserInsights"];
|
|
2828
|
+
put?: never;
|
|
2829
|
+
post?: never;
|
|
2830
|
+
delete?: never;
|
|
2831
|
+
options?: never;
|
|
2832
|
+
head?: never;
|
|
2833
|
+
patch?: never;
|
|
2834
|
+
trace?: never;
|
|
2835
|
+
};
|
|
2836
|
+
"/api/v1/admin/users/{id}/resource-creation-metrics": {
|
|
2837
|
+
parameters: {
|
|
2838
|
+
query?: never;
|
|
2839
|
+
header?: never;
|
|
2840
|
+
path?: never;
|
|
2841
|
+
cookie?: never;
|
|
2842
|
+
};
|
|
2843
|
+
/**
|
|
2844
|
+
* Get a user's resource creation series
|
|
2845
|
+
* @description Returns how many resources of each type the user created per bucket over a
|
|
2846
|
+
* time range. Omitting the parameters yields the last 30 days at `day`
|
|
2847
|
+
* granularity, and the range rules match getAdminDashboardTimeseries. Every
|
|
2848
|
+
* bucket is present with an explicit 0 for every type.
|
|
2849
|
+
*
|
|
2850
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2851
|
+
* does an unknown user id.
|
|
2852
|
+
*/
|
|
2853
|
+
get: operations["getAdminUserResourceCreationMetrics"];
|
|
2854
|
+
put?: never;
|
|
2855
|
+
post?: never;
|
|
2856
|
+
delete?: never;
|
|
2857
|
+
options?: never;
|
|
2858
|
+
head?: never;
|
|
2859
|
+
patch?: never;
|
|
2860
|
+
trace?: never;
|
|
2861
|
+
};
|
|
2862
|
+
"/api/v1/admin/users/{id}/timeline": {
|
|
2863
|
+
parameters: {
|
|
2864
|
+
query?: never;
|
|
2865
|
+
header?: never;
|
|
2866
|
+
path?: never;
|
|
2867
|
+
cookie?: never;
|
|
2868
|
+
};
|
|
2869
|
+
/**
|
|
2870
|
+
* Get a user's resource timeline
|
|
2871
|
+
* @description Returns an opaque, newest-first timeline of the resources the user created
|
|
2872
|
+
* or updated: resource type, action, team, project and the first 8 characters
|
|
2873
|
+
* of the resource id — never a title, slug or content. Cursor-paginated: pass
|
|
2874
|
+
* the previous page's `next_cursor` to continue.
|
|
2875
|
+
*
|
|
2876
|
+
* `updated` events are APPROXIMATE, by construction of the data:
|
|
2877
|
+
*
|
|
2878
|
+
* - Only the latest `updated_at` is stored, so a resource edited many times
|
|
2879
|
+
* appears as ONE `updated` event, at its latest edit.
|
|
2880
|
+
* - There is no `updated_by` column. The event means "a resource authored by
|
|
2881
|
+
* this user was last modified", not "this user edited it" — a teammate's
|
|
2882
|
+
* edit, or a system write that bumps `updated_at` (for example a blueprint
|
|
2883
|
+
* GitHub re-sync or a team-wide artifact type rename), shows up here too.
|
|
2884
|
+
* - An update is only reported when `updated_at` is more than one second after
|
|
2885
|
+
* `created_at`, so a never-edited resource produces no `updated` event.
|
|
2886
|
+
* - Agents, feed items and attachments only ever produce `created` events.
|
|
2887
|
+
*
|
|
2888
|
+
* Deleted resources leave no trace (resources are hard-deleted).
|
|
2889
|
+
*
|
|
2890
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2891
|
+
* does an unknown user id.
|
|
2892
|
+
*/
|
|
2893
|
+
get: operations["getAdminUserTimeline"];
|
|
2894
|
+
put?: never;
|
|
2895
|
+
post?: never;
|
|
2896
|
+
delete?: never;
|
|
2897
|
+
options?: never;
|
|
2898
|
+
head?: never;
|
|
2899
|
+
patch?: never;
|
|
2900
|
+
trace?: never;
|
|
2901
|
+
};
|
|
2902
|
+
"/api/v1/admin/users/{id}/resource-access-metrics": {
|
|
2903
|
+
parameters: {
|
|
2904
|
+
query?: never;
|
|
2905
|
+
header?: never;
|
|
2906
|
+
path?: never;
|
|
2907
|
+
cookie?: never;
|
|
2908
|
+
};
|
|
2909
|
+
/**
|
|
2910
|
+
* Get a user's resource access series by source
|
|
2911
|
+
* @description Returns how many times the user accessed (opened) resources per bucket and
|
|
2912
|
+
* per access source (web, cli, mcp, api), across every team. Omitting the
|
|
2913
|
+
* parameters yields the last 30 days at `day` granularity, and the range
|
|
2914
|
+
* rules match getAdminDashboardTimeseries. Every bucket is present with an
|
|
2915
|
+
* explicit 0 for each source that appears in the range.
|
|
2916
|
+
*
|
|
2917
|
+
* Access events are TTL-pruned (`retention.access_event_days`), so a range
|
|
2918
|
+
* reaching back before `earliest_retained_at` reads as zeros there.
|
|
2919
|
+
*
|
|
2920
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2921
|
+
* does an unknown user id.
|
|
2922
|
+
*/
|
|
2923
|
+
get: operations["getAdminUserResourceAccessMetrics"];
|
|
2924
|
+
put?: never;
|
|
2925
|
+
post?: never;
|
|
2926
|
+
delete?: never;
|
|
2927
|
+
options?: never;
|
|
2928
|
+
head?: never;
|
|
2929
|
+
patch?: never;
|
|
2930
|
+
trace?: never;
|
|
2931
|
+
};
|
|
2932
|
+
"/api/v1/admin/users/{id}/top-accessed-resources": {
|
|
2933
|
+
parameters: {
|
|
2934
|
+
query?: never;
|
|
2935
|
+
header?: never;
|
|
2936
|
+
path?: never;
|
|
2937
|
+
cookie?: never;
|
|
2938
|
+
};
|
|
2939
|
+
/**
|
|
2940
|
+
* Get the resources a user accessed most
|
|
2941
|
+
* @description Returns the resources the user accessed most often in a time range, across
|
|
2942
|
+
* every team, ranked by access count (ties broken by resource id). Rows are
|
|
2943
|
+
* OPAQUE: resource type, team, project and the first 8 characters of the
|
|
2944
|
+
* resource id — never a title, slug or content. A resource deleted since it
|
|
2945
|
+
* was accessed is still listed, with `resource_deleted: true` and no project.
|
|
2946
|
+
*
|
|
2947
|
+
* `from` defaults to 30 days before `to`, and `to` to now. Access events are
|
|
2948
|
+
* TTL-pruned (`retention.access_event_days`), so accesses before
|
|
2949
|
+
* `earliest_retained_at` are not counted.
|
|
2950
|
+
*
|
|
2951
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2952
|
+
* does an unknown user id.
|
|
2953
|
+
*/
|
|
2954
|
+
get: operations["getAdminUserTopAccessedResources"];
|
|
2955
|
+
put?: never;
|
|
2956
|
+
post?: never;
|
|
2957
|
+
delete?: never;
|
|
2958
|
+
options?: never;
|
|
2959
|
+
head?: never;
|
|
2960
|
+
patch?: never;
|
|
2961
|
+
trace?: never;
|
|
2962
|
+
};
|
|
2963
|
+
"/api/v1/admin/users/{id}/notification-preferences": {
|
|
2964
|
+
parameters: {
|
|
2965
|
+
query?: never;
|
|
2966
|
+
header?: never;
|
|
2967
|
+
path?: never;
|
|
2968
|
+
cookie?: never;
|
|
2969
|
+
};
|
|
2970
|
+
/**
|
|
2971
|
+
* Get a user's notification preferences
|
|
2972
|
+
* @description Returns the user's notification preferences, read-only. A user who has never
|
|
2973
|
+
* saved preferences gets the defaults with `is_default: true`.
|
|
2974
|
+
*
|
|
2975
|
+
* Instance-admin only; non-admin and unauthenticated requests receive 404, as
|
|
2976
|
+
* does an unknown user id.
|
|
2977
|
+
*/
|
|
2978
|
+
get: operations["getAdminUserNotificationPreferences"];
|
|
2979
|
+
put?: never;
|
|
2980
|
+
post?: never;
|
|
2981
|
+
delete?: never;
|
|
2982
|
+
options?: never;
|
|
2983
|
+
head?: never;
|
|
2984
|
+
patch?: never;
|
|
2985
|
+
trace?: never;
|
|
2986
|
+
};
|
|
2809
2987
|
"/api/v1/{team_id}/comments": {
|
|
2810
2988
|
parameters: {
|
|
2811
2989
|
query?: never;
|
|
@@ -10950,6 +11128,231 @@ export interface components {
|
|
|
10950
11128
|
/** Format: date-time */
|
|
10951
11129
|
updated_at: string;
|
|
10952
11130
|
};
|
|
11131
|
+
/**
|
|
11132
|
+
* @description How many PROJECT-SCOPED resources the user authored in one project. Only the
|
|
11133
|
+
* four types with a NOT NULL project_id are attributed to a project; every
|
|
11134
|
+
* other type is counted at the team level only.
|
|
11135
|
+
*/
|
|
11136
|
+
AdminUserProjectResourceCounts: {
|
|
11137
|
+
/** Format: uuid */
|
|
11138
|
+
project_id: string;
|
|
11139
|
+
/** @example Platform */
|
|
11140
|
+
project_name: string;
|
|
11141
|
+
counts: components["schemas"]["AdminProjectResourceCounts"];
|
|
11142
|
+
};
|
|
11143
|
+
/** @description How many resources the user authored in one team, with the per-project breakdown. */
|
|
11144
|
+
AdminUserTeamResourceCounts: {
|
|
11145
|
+
/** Format: uuid */
|
|
11146
|
+
team_id: string;
|
|
11147
|
+
/** @example Acme */
|
|
11148
|
+
team_name: string;
|
|
11149
|
+
/**
|
|
11150
|
+
* @description Whether the user is still a member of the team. A former member's
|
|
11151
|
+
* authored resources stay in the team and are still counted here.
|
|
11152
|
+
*/
|
|
11153
|
+
is_member: boolean;
|
|
11154
|
+
counts: components["schemas"]["AdminResourceCounts"];
|
|
11155
|
+
/** @description Per-project counts, ordered by project name. */
|
|
11156
|
+
projects: components["schemas"]["AdminUserProjectResourceCounts"][];
|
|
11157
|
+
};
|
|
11158
|
+
/**
|
|
11159
|
+
* @description Per-type counts of the resources one user authored, instance-wide, per team
|
|
11160
|
+
* and per project (GET /api/v1/admin/users/{id}/insights). For every type the
|
|
11161
|
+
* per-team counts sum to `totals`. An attachment whose author was deleted
|
|
11162
|
+
* (user_id set to NULL) counts for nobody.
|
|
11163
|
+
*/
|
|
11164
|
+
AdminUserInsights: {
|
|
11165
|
+
/** Format: uuid */
|
|
11166
|
+
user_id: string;
|
|
11167
|
+
totals: components["schemas"]["AdminResourceCounts"];
|
|
11168
|
+
/** @description Teams the user authored at least one resource in, ordered by team name. */
|
|
11169
|
+
teams: components["schemas"]["AdminUserTeamResourceCounts"][];
|
|
11170
|
+
};
|
|
11171
|
+
/** @description How many resources of each type the user created within one time bucket. */
|
|
11172
|
+
AdminUserCreationPoint: {
|
|
11173
|
+
/**
|
|
11174
|
+
* Format: date-time
|
|
11175
|
+
* @description Start of the bucket, in UTC.
|
|
11176
|
+
*/
|
|
11177
|
+
bucket: string;
|
|
11178
|
+
/** Format: int64 */
|
|
11179
|
+
prompts: number;
|
|
11180
|
+
/** Format: int64 */
|
|
11181
|
+
memories: number;
|
|
11182
|
+
/** Format: int64 */
|
|
11183
|
+
artifacts: number;
|
|
11184
|
+
/** Format: int64 */
|
|
11185
|
+
blueprints: number;
|
|
11186
|
+
/** Format: int64 */
|
|
11187
|
+
agents: number;
|
|
11188
|
+
/** Format: int64 */
|
|
11189
|
+
feeds: number;
|
|
11190
|
+
/** Format: int64 */
|
|
11191
|
+
feed_items: number;
|
|
11192
|
+
/** Format: int64 */
|
|
11193
|
+
comments: number;
|
|
11194
|
+
/** Format: int64 */
|
|
11195
|
+
attachments: number;
|
|
11196
|
+
};
|
|
11197
|
+
/**
|
|
11198
|
+
* @description Resources the user created per bucket, stacked by type
|
|
11199
|
+
* (GET /api/v1/admin/users/{id}/resource-creation-metrics). Every bucket in
|
|
11200
|
+
* the range is present with an explicit 0 for every type.
|
|
11201
|
+
*/
|
|
11202
|
+
AdminUserResourceCreationMetrics: {
|
|
11203
|
+
/**
|
|
11204
|
+
* Format: date-time
|
|
11205
|
+
* @description Inclusive start of the range actually used, snapped DOWN to the start of
|
|
11206
|
+
* its bucket (same rule as AdminTimeseriesResponse.from).
|
|
11207
|
+
*/
|
|
11208
|
+
from: string;
|
|
11209
|
+
/**
|
|
11210
|
+
* Format: date-time
|
|
11211
|
+
* @description Exclusive end of the range actually used (after defaulting); not snapped.
|
|
11212
|
+
*/
|
|
11213
|
+
to: string;
|
|
11214
|
+
/**
|
|
11215
|
+
* @description Bucket size actually used.
|
|
11216
|
+
* @enum {string}
|
|
11217
|
+
*/
|
|
11218
|
+
granularity: "day" | "week" | "month";
|
|
11219
|
+
/** @description One point per bucket, ascending by bucket. */
|
|
11220
|
+
series: components["schemas"]["AdminUserCreationPoint"][];
|
|
11221
|
+
};
|
|
11222
|
+
/**
|
|
11223
|
+
* @description One opaque timeline entry: which kind of resource the user created or last
|
|
11224
|
+
* updated, where, and when. Deliberately carries no title, slug or content —
|
|
11225
|
+
* only the first 8 characters of the resource id.
|
|
11226
|
+
*/
|
|
11227
|
+
AdminUserTimelineEvent: {
|
|
11228
|
+
/** @enum {string} */
|
|
11229
|
+
resource_type: "prompt" | "memory" | "artifact" | "blueprint" | "agent" | "feed" | "feed_item" | "comment" | "attachment";
|
|
11230
|
+
/** @enum {string} */
|
|
11231
|
+
action: "created" | "updated";
|
|
11232
|
+
/** Format: uuid */
|
|
11233
|
+
team_id: string;
|
|
11234
|
+
team_name: string;
|
|
11235
|
+
/**
|
|
11236
|
+
* Format: uuid
|
|
11237
|
+
* @description Null for team-scoped resources and for feed items posted without a project.
|
|
11238
|
+
*/
|
|
11239
|
+
project_id: string | null;
|
|
11240
|
+
project_name: string | null;
|
|
11241
|
+
/**
|
|
11242
|
+
* @description First 8 characters of the resource id.
|
|
11243
|
+
* @example 3f2a9c1e
|
|
11244
|
+
*/
|
|
11245
|
+
resource_short_id: string;
|
|
11246
|
+
/** Format: date-time */
|
|
11247
|
+
occurred_at: string;
|
|
11248
|
+
};
|
|
11249
|
+
/** @description One page of a user's resource timeline, newest first. */
|
|
11250
|
+
AdminUserTimelinePage: {
|
|
11251
|
+
items: components["schemas"]["AdminUserTimelineEvent"][];
|
|
11252
|
+
/** @description Opaque cursor for the next page; null on the last page. */
|
|
11253
|
+
next_cursor: string | null;
|
|
11254
|
+
};
|
|
11255
|
+
/**
|
|
11256
|
+
* @description A user's notification preferences, read-only
|
|
11257
|
+
* (GET /api/v1/admin/users/{id}/notification-preferences). When the user has
|
|
11258
|
+
* never saved preferences, the defaults are returned with `is_default: true`
|
|
11259
|
+
* and `updated_at: null`.
|
|
11260
|
+
*/
|
|
11261
|
+
AdminUserNotificationPreferences: {
|
|
11262
|
+
email_notification: components["schemas"]["EmailNotificationPreferences"];
|
|
11263
|
+
notifications: components["schemas"]["NotificationPreferences"];
|
|
11264
|
+
/**
|
|
11265
|
+
* Format: date-time
|
|
11266
|
+
* @description When the user last saved their preferences; null when defaults are returned.
|
|
11267
|
+
*/
|
|
11268
|
+
updated_at: string | null;
|
|
11269
|
+
/** @description True when the user has no stored preferences and the defaults are shown. */
|
|
11270
|
+
is_default: boolean;
|
|
11271
|
+
};
|
|
11272
|
+
/**
|
|
11273
|
+
* @description Resource accesses by the user per bucket and source, across every team
|
|
11274
|
+
* (GET /api/v1/admin/users/{id}/resource-access-metrics). Every bucket in the
|
|
11275
|
+
* range is present with an explicit 0 for each source that appears.
|
|
11276
|
+
*/
|
|
11277
|
+
AdminUserAccessMetrics: {
|
|
11278
|
+
/**
|
|
11279
|
+
* Format: date-time
|
|
11280
|
+
* @description Inclusive start of the range actually used, snapped DOWN to the start of
|
|
11281
|
+
* its bucket (same rule as AdminTimeseriesResponse.from).
|
|
11282
|
+
*/
|
|
11283
|
+
from: string;
|
|
11284
|
+
/**
|
|
11285
|
+
* Format: date-time
|
|
11286
|
+
* @description Exclusive end of the range actually used (after defaulting); not snapped.
|
|
11287
|
+
*/
|
|
11288
|
+
to: string;
|
|
11289
|
+
/**
|
|
11290
|
+
* @description Bucket size actually used.
|
|
11291
|
+
* @enum {string}
|
|
11292
|
+
*/
|
|
11293
|
+
granularity: "day" | "week" | "month";
|
|
11294
|
+
/** @description One point per (bucket, source), ascending by bucket then source. */
|
|
11295
|
+
access_by_source: components["schemas"]["AdminSourcePoint"][];
|
|
11296
|
+
/**
|
|
11297
|
+
* Format: date-time
|
|
11298
|
+
* @description Oldest access event still retained (now minus
|
|
11299
|
+
* `retention.access_event_days`); buckets before it read as zeros.
|
|
11300
|
+
*/
|
|
11301
|
+
earliest_retained_at: string;
|
|
11302
|
+
};
|
|
11303
|
+
/**
|
|
11304
|
+
* @description One opaque most-accessed resource: its type, where it lives and how often
|
|
11305
|
+
* the user accessed it. Deliberately carries no title, slug or content — only
|
|
11306
|
+
* the first 8 characters of the resource id. The identity fields share their
|
|
11307
|
+
* names with AdminUserTimelineEvent.
|
|
11308
|
+
*/
|
|
11309
|
+
AdminTopAccessedResource: {
|
|
11310
|
+
/** @enum {string} */
|
|
11311
|
+
resource_type: "prompt" | "artifact" | "blueprint" | "memory" | "project" | "agent";
|
|
11312
|
+
/**
|
|
11313
|
+
* @description First 8 characters of the resource id.
|
|
11314
|
+
* @example 3f2a9c1e
|
|
11315
|
+
*/
|
|
11316
|
+
resource_short_id: string;
|
|
11317
|
+
/** Format: uuid */
|
|
11318
|
+
team_id: string;
|
|
11319
|
+
team_name: string;
|
|
11320
|
+
/**
|
|
11321
|
+
* Format: uuid
|
|
11322
|
+
* @description The resource's project (for a `project` row, the project itself). Null
|
|
11323
|
+
* for agents and for deleted resources.
|
|
11324
|
+
*/
|
|
11325
|
+
project_id: string | null;
|
|
11326
|
+
project_name: string | null;
|
|
11327
|
+
/** @description True when the resource no longer exists (access events outlive their resource until pruned). */
|
|
11328
|
+
resource_deleted: boolean;
|
|
11329
|
+
/** Format: int64 */
|
|
11330
|
+
access_count: number;
|
|
11331
|
+
};
|
|
11332
|
+
/**
|
|
11333
|
+
* @description The resources a user accessed most in a range
|
|
11334
|
+
* (GET /api/v1/admin/users/{id}/top-accessed-resources).
|
|
11335
|
+
*/
|
|
11336
|
+
AdminTopAccessedResourcesResponse: {
|
|
11337
|
+
/**
|
|
11338
|
+
* Format: date-time
|
|
11339
|
+
* @description Inclusive start of the range actually used (after defaulting); not snapped.
|
|
11340
|
+
*/
|
|
11341
|
+
from: string;
|
|
11342
|
+
/**
|
|
11343
|
+
* Format: date-time
|
|
11344
|
+
* @description Exclusive end of the range actually used (after defaulting).
|
|
11345
|
+
*/
|
|
11346
|
+
to: string;
|
|
11347
|
+
/** @description Most accessed first; ties broken by resource id. */
|
|
11348
|
+
items: components["schemas"]["AdminTopAccessedResource"][];
|
|
11349
|
+
/**
|
|
11350
|
+
* Format: date-time
|
|
11351
|
+
* @description Oldest access event still retained (now minus
|
|
11352
|
+
* `retention.access_event_days`); accesses before it are not counted.
|
|
11353
|
+
*/
|
|
11354
|
+
earliest_retained_at: string;
|
|
11355
|
+
};
|
|
10953
11356
|
ProjectResponse: components["schemas"]["Project"] & {
|
|
10954
11357
|
/**
|
|
10955
11358
|
* @description Whether the project's git URL matches a repository accessible via the team's GitHub App installation
|
|
@@ -11089,16 +11492,45 @@ export interface components {
|
|
|
11089
11492
|
*/
|
|
11090
11493
|
data: string[];
|
|
11091
11494
|
};
|
|
11092
|
-
|
|
11093
|
-
preferences: components["schemas"]["Preferences"];
|
|
11495
|
+
EmailNotificationPreferences: {
|
|
11094
11496
|
/**
|
|
11095
|
-
*
|
|
11096
|
-
* @
|
|
11097
|
-
* @example 2024-01-20T14:45:00Z
|
|
11497
|
+
* @description Receive platform announcement emails
|
|
11498
|
+
* @example true
|
|
11098
11499
|
*/
|
|
11099
|
-
|
|
11100
|
-
|
|
11101
|
-
|
|
11500
|
+
platform_announcement: boolean;
|
|
11501
|
+
/**
|
|
11502
|
+
* @description Receive account security emails
|
|
11503
|
+
* @example true
|
|
11504
|
+
*/
|
|
11505
|
+
account_security: boolean;
|
|
11506
|
+
/**
|
|
11507
|
+
* @description Receive new feature emails
|
|
11508
|
+
* @example true
|
|
11509
|
+
*/
|
|
11510
|
+
new_feature: boolean;
|
|
11511
|
+
/**
|
|
11512
|
+
* @description Receive marketing and promotional emails
|
|
11513
|
+
* @example false
|
|
11514
|
+
*/
|
|
11515
|
+
marketing_promotional: boolean;
|
|
11516
|
+
};
|
|
11517
|
+
NotificationPreferences: {
|
|
11518
|
+
channels: components["schemas"]["NotificationChannelPreferences"];
|
|
11519
|
+
/** @description Per-type delivery preferences keyed by notification type (e.g. "feed.item.created", "feed.reply.created") */
|
|
11520
|
+
types: {
|
|
11521
|
+
[key: string]: components["schemas"]["NotificationTypePreference"];
|
|
11522
|
+
};
|
|
11523
|
+
};
|
|
11524
|
+
PreferencesResponse: {
|
|
11525
|
+
preferences: components["schemas"]["Preferences"];
|
|
11526
|
+
/**
|
|
11527
|
+
* Format: date-time
|
|
11528
|
+
* @description When the preferences were last persisted. Zero value (0001-01-01T00:00:00Z) when the user has never saved preferences and defaults are being returned.
|
|
11529
|
+
* @example 2024-01-20T14:45:00Z
|
|
11530
|
+
*/
|
|
11531
|
+
updated_at: string;
|
|
11532
|
+
};
|
|
11533
|
+
UpdatePreferencesRequest: {
|
|
11102
11534
|
email_notification?: components["schemas"]["EmailNotificationPreferences"];
|
|
11103
11535
|
notifications?: components["schemas"]["NotificationPreferences"];
|
|
11104
11536
|
};
|
|
@@ -11398,28 +11830,6 @@ export interface components {
|
|
|
11398
11830
|
range: "7d" | "14d" | "30d" | "60d" | "90d" | "180d";
|
|
11399
11831
|
items: components["schemas"]["TopAccessedResourceItem"][];
|
|
11400
11832
|
};
|
|
11401
|
-
EmailNotificationPreferences: {
|
|
11402
|
-
/**
|
|
11403
|
-
* @description Receive platform announcement emails
|
|
11404
|
-
* @example true
|
|
11405
|
-
*/
|
|
11406
|
-
platform_announcement: boolean;
|
|
11407
|
-
/**
|
|
11408
|
-
* @description Receive account security emails
|
|
11409
|
-
* @example true
|
|
11410
|
-
*/
|
|
11411
|
-
account_security: boolean;
|
|
11412
|
-
/**
|
|
11413
|
-
* @description Receive new feature emails
|
|
11414
|
-
* @example true
|
|
11415
|
-
*/
|
|
11416
|
-
new_feature: boolean;
|
|
11417
|
-
/**
|
|
11418
|
-
* @description Receive marketing and promotional emails
|
|
11419
|
-
* @example false
|
|
11420
|
-
*/
|
|
11421
|
-
marketing_promotional: boolean;
|
|
11422
|
-
};
|
|
11423
11833
|
NotificationChannelPreferences: {
|
|
11424
11834
|
/**
|
|
11425
11835
|
* @description Enable in-app notifications globally
|
|
@@ -11445,13 +11855,6 @@ export interface components {
|
|
|
11445
11855
|
*/
|
|
11446
11856
|
email: "instant" | "digest" | "none";
|
|
11447
11857
|
};
|
|
11448
|
-
NotificationPreferences: {
|
|
11449
|
-
channels: components["schemas"]["NotificationChannelPreferences"];
|
|
11450
|
-
/** @description Per-type delivery preferences keyed by notification type (e.g. "feed.item.created", "feed.reply.created") */
|
|
11451
|
-
types: {
|
|
11452
|
-
[key: string]: components["schemas"]["NotificationTypePreference"];
|
|
11453
|
-
};
|
|
11454
|
-
};
|
|
11455
11858
|
Preferences: {
|
|
11456
11859
|
email_notification: components["schemas"]["EmailNotificationPreferences"];
|
|
11457
11860
|
notifications: components["schemas"]["NotificationPreferences"];
|
|
@@ -20903,6 +21306,341 @@ export interface operations {
|
|
|
20903
21306
|
};
|
|
20904
21307
|
};
|
|
20905
21308
|
};
|
|
21309
|
+
getAdminUserInsights: {
|
|
21310
|
+
parameters: {
|
|
21311
|
+
query?: never;
|
|
21312
|
+
header?: never;
|
|
21313
|
+
path: {
|
|
21314
|
+
/** @description User id (UUID) */
|
|
21315
|
+
id: string;
|
|
21316
|
+
};
|
|
21317
|
+
cookie?: never;
|
|
21318
|
+
};
|
|
21319
|
+
requestBody?: never;
|
|
21320
|
+
responses: {
|
|
21321
|
+
/** @description The user's per-type resource counts */
|
|
21322
|
+
200: {
|
|
21323
|
+
headers: {
|
|
21324
|
+
[name: string]: unknown;
|
|
21325
|
+
};
|
|
21326
|
+
content: {
|
|
21327
|
+
"application/json": components["schemas"]["AdminUserInsights"];
|
|
21328
|
+
};
|
|
21329
|
+
};
|
|
21330
|
+
/** @description Bad request — malformed user id */
|
|
21331
|
+
400: {
|
|
21332
|
+
headers: {
|
|
21333
|
+
[name: string]: unknown;
|
|
21334
|
+
};
|
|
21335
|
+
content: {
|
|
21336
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21337
|
+
};
|
|
21338
|
+
};
|
|
21339
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21340
|
+
404: {
|
|
21341
|
+
headers: {
|
|
21342
|
+
[name: string]: unknown;
|
|
21343
|
+
};
|
|
21344
|
+
content: {
|
|
21345
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21346
|
+
};
|
|
21347
|
+
};
|
|
21348
|
+
/** @description Internal server error */
|
|
21349
|
+
500: {
|
|
21350
|
+
headers: {
|
|
21351
|
+
[name: string]: unknown;
|
|
21352
|
+
};
|
|
21353
|
+
content: {
|
|
21354
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21355
|
+
};
|
|
21356
|
+
};
|
|
21357
|
+
};
|
|
21358
|
+
};
|
|
21359
|
+
getAdminUserResourceCreationMetrics: {
|
|
21360
|
+
parameters: {
|
|
21361
|
+
query?: {
|
|
21362
|
+
/** @description Inclusive start of the range. Defaults to 30 days before `to`. */
|
|
21363
|
+
from?: string;
|
|
21364
|
+
/** @description Exclusive end of the range. Defaults to now. */
|
|
21365
|
+
to?: string;
|
|
21366
|
+
/** @description Bucket size. */
|
|
21367
|
+
granularity?: "day" | "week" | "month";
|
|
21368
|
+
};
|
|
21369
|
+
header?: never;
|
|
21370
|
+
path: {
|
|
21371
|
+
/** @description User id (UUID) */
|
|
21372
|
+
id: string;
|
|
21373
|
+
};
|
|
21374
|
+
cookie?: never;
|
|
21375
|
+
};
|
|
21376
|
+
requestBody?: never;
|
|
21377
|
+
responses: {
|
|
21378
|
+
/** @description Bucketed creation counts per type */
|
|
21379
|
+
200: {
|
|
21380
|
+
headers: {
|
|
21381
|
+
[name: string]: unknown;
|
|
21382
|
+
};
|
|
21383
|
+
content: {
|
|
21384
|
+
"application/json": components["schemas"]["AdminUserResourceCreationMetrics"];
|
|
21385
|
+
};
|
|
21386
|
+
};
|
|
21387
|
+
/**
|
|
21388
|
+
* @description Bad request — malformed user id, `to` is not after `from`, the range
|
|
21389
|
+
* exceeds the maximum span, or `granularity` is outside its enum
|
|
21390
|
+
*/
|
|
21391
|
+
400: {
|
|
21392
|
+
headers: {
|
|
21393
|
+
[name: string]: unknown;
|
|
21394
|
+
};
|
|
21395
|
+
content: {
|
|
21396
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21397
|
+
};
|
|
21398
|
+
};
|
|
21399
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21400
|
+
404: {
|
|
21401
|
+
headers: {
|
|
21402
|
+
[name: string]: unknown;
|
|
21403
|
+
};
|
|
21404
|
+
content: {
|
|
21405
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21406
|
+
};
|
|
21407
|
+
};
|
|
21408
|
+
/** @description Internal server error */
|
|
21409
|
+
500: {
|
|
21410
|
+
headers: {
|
|
21411
|
+
[name: string]: unknown;
|
|
21412
|
+
};
|
|
21413
|
+
content: {
|
|
21414
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21415
|
+
};
|
|
21416
|
+
};
|
|
21417
|
+
};
|
|
21418
|
+
};
|
|
21419
|
+
getAdminUserTimeline: {
|
|
21420
|
+
parameters: {
|
|
21421
|
+
query?: {
|
|
21422
|
+
/** @description Opaque cursor from a previous page's `next_cursor`. */
|
|
21423
|
+
cursor?: string;
|
|
21424
|
+
/** @description Page size. */
|
|
21425
|
+
limit?: number;
|
|
21426
|
+
};
|
|
21427
|
+
header?: never;
|
|
21428
|
+
path: {
|
|
21429
|
+
/** @description User id (UUID) */
|
|
21430
|
+
id: string;
|
|
21431
|
+
};
|
|
21432
|
+
cookie?: never;
|
|
21433
|
+
};
|
|
21434
|
+
requestBody?: never;
|
|
21435
|
+
responses: {
|
|
21436
|
+
/** @description One page of timeline events, newest first */
|
|
21437
|
+
200: {
|
|
21438
|
+
headers: {
|
|
21439
|
+
[name: string]: unknown;
|
|
21440
|
+
};
|
|
21441
|
+
content: {
|
|
21442
|
+
"application/json": components["schemas"]["AdminUserTimelinePage"];
|
|
21443
|
+
};
|
|
21444
|
+
};
|
|
21445
|
+
/** @description Bad request — malformed user id, malformed cursor, or `limit` out of range */
|
|
21446
|
+
400: {
|
|
21447
|
+
headers: {
|
|
21448
|
+
[name: string]: unknown;
|
|
21449
|
+
};
|
|
21450
|
+
content: {
|
|
21451
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21452
|
+
};
|
|
21453
|
+
};
|
|
21454
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21455
|
+
404: {
|
|
21456
|
+
headers: {
|
|
21457
|
+
[name: string]: unknown;
|
|
21458
|
+
};
|
|
21459
|
+
content: {
|
|
21460
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21461
|
+
};
|
|
21462
|
+
};
|
|
21463
|
+
/** @description Internal server error */
|
|
21464
|
+
500: {
|
|
21465
|
+
headers: {
|
|
21466
|
+
[name: string]: unknown;
|
|
21467
|
+
};
|
|
21468
|
+
content: {
|
|
21469
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21470
|
+
};
|
|
21471
|
+
};
|
|
21472
|
+
};
|
|
21473
|
+
};
|
|
21474
|
+
getAdminUserResourceAccessMetrics: {
|
|
21475
|
+
parameters: {
|
|
21476
|
+
query?: {
|
|
21477
|
+
/** @description Inclusive start of the range. Defaults to 30 days before `to`. */
|
|
21478
|
+
from?: string;
|
|
21479
|
+
/** @description Exclusive end of the range. Defaults to now. */
|
|
21480
|
+
to?: string;
|
|
21481
|
+
/** @description Bucket size. */
|
|
21482
|
+
granularity?: "day" | "week" | "month";
|
|
21483
|
+
};
|
|
21484
|
+
header?: never;
|
|
21485
|
+
path: {
|
|
21486
|
+
/** @description User id (UUID) */
|
|
21487
|
+
id: string;
|
|
21488
|
+
};
|
|
21489
|
+
cookie?: never;
|
|
21490
|
+
};
|
|
21491
|
+
requestBody?: never;
|
|
21492
|
+
responses: {
|
|
21493
|
+
/** @description Bucketed access counts per source */
|
|
21494
|
+
200: {
|
|
21495
|
+
headers: {
|
|
21496
|
+
[name: string]: unknown;
|
|
21497
|
+
};
|
|
21498
|
+
content: {
|
|
21499
|
+
"application/json": components["schemas"]["AdminUserAccessMetrics"];
|
|
21500
|
+
};
|
|
21501
|
+
};
|
|
21502
|
+
/**
|
|
21503
|
+
* @description Bad request — malformed user id, `to` is not after `from`, the range
|
|
21504
|
+
* exceeds the maximum span, or `granularity` is outside its enum
|
|
21505
|
+
*/
|
|
21506
|
+
400: {
|
|
21507
|
+
headers: {
|
|
21508
|
+
[name: string]: unknown;
|
|
21509
|
+
};
|
|
21510
|
+
content: {
|
|
21511
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21512
|
+
};
|
|
21513
|
+
};
|
|
21514
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21515
|
+
404: {
|
|
21516
|
+
headers: {
|
|
21517
|
+
[name: string]: unknown;
|
|
21518
|
+
};
|
|
21519
|
+
content: {
|
|
21520
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21521
|
+
};
|
|
21522
|
+
};
|
|
21523
|
+
/** @description Internal server error */
|
|
21524
|
+
500: {
|
|
21525
|
+
headers: {
|
|
21526
|
+
[name: string]: unknown;
|
|
21527
|
+
};
|
|
21528
|
+
content: {
|
|
21529
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21530
|
+
};
|
|
21531
|
+
};
|
|
21532
|
+
};
|
|
21533
|
+
};
|
|
21534
|
+
getAdminUserTopAccessedResources: {
|
|
21535
|
+
parameters: {
|
|
21536
|
+
query?: {
|
|
21537
|
+
/** @description Inclusive start of the range. Defaults to 30 days before `to`. */
|
|
21538
|
+
from?: string;
|
|
21539
|
+
/** @description Exclusive end of the range. Defaults to now. */
|
|
21540
|
+
to?: string;
|
|
21541
|
+
/** @description Maximum number of rows. */
|
|
21542
|
+
limit?: number;
|
|
21543
|
+
};
|
|
21544
|
+
header?: never;
|
|
21545
|
+
path: {
|
|
21546
|
+
/** @description User id (UUID) */
|
|
21547
|
+
id: string;
|
|
21548
|
+
};
|
|
21549
|
+
cookie?: never;
|
|
21550
|
+
};
|
|
21551
|
+
requestBody?: never;
|
|
21552
|
+
responses: {
|
|
21553
|
+
/** @description The most-accessed resources, most accessed first */
|
|
21554
|
+
200: {
|
|
21555
|
+
headers: {
|
|
21556
|
+
[name: string]: unknown;
|
|
21557
|
+
};
|
|
21558
|
+
content: {
|
|
21559
|
+
"application/json": components["schemas"]["AdminTopAccessedResourcesResponse"];
|
|
21560
|
+
};
|
|
21561
|
+
};
|
|
21562
|
+
/**
|
|
21563
|
+
* @description Bad request — malformed user id, `to` is not after `from`, the range
|
|
21564
|
+
* exceeds the maximum span, or `limit` is out of range
|
|
21565
|
+
*/
|
|
21566
|
+
400: {
|
|
21567
|
+
headers: {
|
|
21568
|
+
[name: string]: unknown;
|
|
21569
|
+
};
|
|
21570
|
+
content: {
|
|
21571
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21572
|
+
};
|
|
21573
|
+
};
|
|
21574
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21575
|
+
404: {
|
|
21576
|
+
headers: {
|
|
21577
|
+
[name: string]: unknown;
|
|
21578
|
+
};
|
|
21579
|
+
content: {
|
|
21580
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21581
|
+
};
|
|
21582
|
+
};
|
|
21583
|
+
/** @description Internal server error */
|
|
21584
|
+
500: {
|
|
21585
|
+
headers: {
|
|
21586
|
+
[name: string]: unknown;
|
|
21587
|
+
};
|
|
21588
|
+
content: {
|
|
21589
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21590
|
+
};
|
|
21591
|
+
};
|
|
21592
|
+
};
|
|
21593
|
+
};
|
|
21594
|
+
getAdminUserNotificationPreferences: {
|
|
21595
|
+
parameters: {
|
|
21596
|
+
query?: never;
|
|
21597
|
+
header?: never;
|
|
21598
|
+
path: {
|
|
21599
|
+
/** @description User id (UUID) */
|
|
21600
|
+
id: string;
|
|
21601
|
+
};
|
|
21602
|
+
cookie?: never;
|
|
21603
|
+
};
|
|
21604
|
+
requestBody?: never;
|
|
21605
|
+
responses: {
|
|
21606
|
+
/** @description The user's notification preferences */
|
|
21607
|
+
200: {
|
|
21608
|
+
headers: {
|
|
21609
|
+
[name: string]: unknown;
|
|
21610
|
+
};
|
|
21611
|
+
content: {
|
|
21612
|
+
"application/json": components["schemas"]["AdminUserNotificationPreferences"];
|
|
21613
|
+
};
|
|
21614
|
+
};
|
|
21615
|
+
/** @description Bad request — malformed user id */
|
|
21616
|
+
400: {
|
|
21617
|
+
headers: {
|
|
21618
|
+
[name: string]: unknown;
|
|
21619
|
+
};
|
|
21620
|
+
content: {
|
|
21621
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21622
|
+
};
|
|
21623
|
+
};
|
|
21624
|
+
/** @description Not found — unknown user id, or the caller is not an instance admin */
|
|
21625
|
+
404: {
|
|
21626
|
+
headers: {
|
|
21627
|
+
[name: string]: unknown;
|
|
21628
|
+
};
|
|
21629
|
+
content: {
|
|
21630
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21631
|
+
};
|
|
21632
|
+
};
|
|
21633
|
+
/** @description Internal server error */
|
|
21634
|
+
500: {
|
|
21635
|
+
headers: {
|
|
21636
|
+
[name: string]: unknown;
|
|
21637
|
+
};
|
|
21638
|
+
content: {
|
|
21639
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
21640
|
+
};
|
|
21641
|
+
};
|
|
21642
|
+
};
|
|
21643
|
+
};
|
|
20906
21644
|
listComments: {
|
|
20907
21645
|
parameters: {
|
|
20908
21646
|
query: {
|