@vibexp/api-client 0.2.0 → 0.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.
@@ -102,11 +102,11 @@ export type ResourceAccessMetricsResponse = {
102
102
  export type User = {
103
103
  id: string;
104
104
  /**
105
- * Legacy Google OAuth subject identifier (may be null for WorkOS-only accounts)
105
+ * Legacy Google OAuth subject identifier (may be null for non-Google accounts)
106
106
  */
107
107
  google_id?: string | null;
108
108
  /**
109
- * Identity provider name (e.g. "workos")
109
+ * Identity provider name (e.g. "google", "oidc")
110
110
  */
111
111
  idp_provider?: string | null;
112
112
  /**
@@ -128,11 +128,11 @@ export type User = {
128
128
  version: number;
129
129
  };
130
130
  /**
131
- * Response body returned by GET /api/v1/auth/login containing the WorkOS authorization URL
131
+ * Response body returned by GET /api/v1/auth/login containing the authorization URL
132
132
  */
133
133
  export type LoginResponse = {
134
134
  /**
135
- * WorkOS authorization URL to redirect the user to for authentication
135
+ * Identity-provider authorization URL to redirect the user to for authentication
136
136
  */
137
137
  url: string;
138
138
  };
@@ -145,6 +145,33 @@ export type LogoutResponse = {
145
145
  */
146
146
  message: string;
147
147
  };
148
+ /**
149
+ * One enabled login provider, with display metadata for the login UI
150
+ */
151
+ export type AuthProvider = {
152
+ /**
153
+ * Canonical provider name, also the value to pass as the `provider`
154
+ * query parameter to GET /api/v1/auth/login (e.g. `google`, `github`,
155
+ * `oidc`).
156
+ *
157
+ */
158
+ name: string;
159
+ /**
160
+ * Human-readable label for the provider button in the login UI
161
+ */
162
+ display_name: string;
163
+ };
164
+ /**
165
+ * Response body returned by GET /api/v1/auth/providers listing the login
166
+ * providers enabled in this deployment's configuration.
167
+ *
168
+ */
169
+ export type ProvidersResponse = {
170
+ /**
171
+ * Enabled login providers, stable-sorted by canonical name
172
+ */
173
+ providers: Array<AuthProvider>;
174
+ };
148
175
  /**
149
176
  * Request body for POST /api/v1/auth/dev/login (development environment only)
150
177
  */
@@ -598,8 +625,24 @@ export type EntityTypesResponse = {
598
625
  export type EmbeddingProvider = {
599
626
  id: string;
600
627
  user_id: string;
628
+ /**
629
+ * Team that owns this provider.
630
+ */
631
+ team_id?: string | null;
601
632
  name: string;
602
633
  provider_type: string;
634
+ /**
635
+ * Embedding model this provider requests. Must return the fixed vector width VibeXP stores (1024).
636
+ */
637
+ model: string;
638
+ /**
639
+ * In-Go text-chunker size used when embedding documents.
640
+ */
641
+ chunk_size: number;
642
+ /**
643
+ * Overlap between adjacent chunks.
644
+ */
645
+ chunk_overlap: number;
603
646
  is_default: boolean;
604
647
  base_url?: string | null;
605
648
  configuration: string;
@@ -616,6 +659,18 @@ export type EmbeddingProviderResponse = EmbeddingProvider & {
616
659
  export type CreateEmbeddingProviderRequest = {
617
660
  name: string;
618
661
  provider_type: string;
662
+ /**
663
+ * Embedding model that must return 1024-dimensional vectors.
664
+ */
665
+ model: string;
666
+ /**
667
+ * Optional chunker size; defaults to 1000 when omitted.
668
+ */
669
+ chunk_size?: number;
670
+ /**
671
+ * Optional chunk overlap; defaults to 200 when omitted.
672
+ */
673
+ chunk_overlap?: number;
619
674
  is_default?: boolean;
620
675
  base_url?: string;
621
676
  api_key?: string | null;
@@ -626,6 +681,9 @@ export type CreateEmbeddingProviderRequest = {
626
681
  export type UpdateEmbeddingProviderRequest = {
627
682
  name?: string;
628
683
  provider_type?: string;
684
+ model?: string;
685
+ chunk_size?: number;
686
+ chunk_overlap?: number;
629
687
  is_default?: boolean;
630
688
  base_url?: string;
631
689
  api_key?: string;
@@ -642,6 +700,10 @@ export type EmbeddingProviderListResponse = {
642
700
  };
643
701
  export type ValidateEmbeddingProviderRequest = {
644
702
  provider_type: string;
703
+ /**
704
+ * Embedding model to probe. The provider is accepted only if it returns vectors of the fixed dimension VibeXP stores (1024).
705
+ */
706
+ model: string;
645
707
  base_url: string;
646
708
  api_key?: string | null;
647
709
  configuration?: {
@@ -654,6 +716,10 @@ export type ValidateEmbeddingProviderResponse = {
654
716
  details?: {
655
717
  response_time_ms?: number;
656
718
  status_code?: number;
719
+ /**
720
+ * Vector width the provider returned during the probe.
721
+ */
722
+ dimension?: number;
657
723
  error_details?: string;
658
724
  };
659
725
  };
@@ -693,16 +759,6 @@ export type ResourceUsageResponse = {
693
759
  */
694
760
  resources?: Array<ResourceUsageItem>;
695
761
  };
696
- export type ContactFormRequest = {
697
- name: string;
698
- email: string;
699
- phone_number?: string | null;
700
- message: string;
701
- };
702
- export type ContactFormResponse = {
703
- message: string;
704
- success: boolean;
705
- };
706
762
  export type SupportRequest = {
707
763
  text: string;
708
764
  additional_info?: {
@@ -3581,29 +3637,67 @@ export type HealthResponse2 = HealthResponses[keyof HealthResponses];
3581
3637
  export type LoginData = {
3582
3638
  body?: never;
3583
3639
  path?: never;
3584
- query?: never;
3640
+ query?: {
3641
+ /**
3642
+ * Canonical name of the identity provider to use (e.g. `google`,
3643
+ * `github`, `oidc`). Optional when a single provider is enabled;
3644
+ * required when more than one is enabled.
3645
+ *
3646
+ */
3647
+ provider?: string;
3648
+ };
3585
3649
  url: '/api/v1/auth/login';
3586
3650
  };
3587
3651
  export type LoginErrors = {
3652
+ /**
3653
+ * The `provider` value is unknown/disabled, or it was omitted while
3654
+ * multiple providers are enabled.
3655
+ *
3656
+ */
3657
+ 400: ErrorResponse;
3588
3658
  /**
3589
3659
  * Internal server error
3590
3660
  */
3591
3661
  500: ErrorResponse;
3662
+ /**
3663
+ * No identity provider is configured (web login unavailable)
3664
+ */
3665
+ 503: ErrorResponse;
3592
3666
  };
3593
3667
  export type LoginError = LoginErrors[keyof LoginErrors];
3594
3668
  export type LoginResponses = {
3595
3669
  /**
3596
- * WorkOS authorization URL generated successfully
3670
+ * Authorization URL generated successfully
3597
3671
  */
3598
3672
  200: LoginResponse;
3599
3673
  };
3600
3674
  export type LoginResponse2 = LoginResponses[keyof LoginResponses];
3675
+ export type ListAuthProvidersData = {
3676
+ body?: never;
3677
+ path?: never;
3678
+ query?: never;
3679
+ url: '/api/v1/auth/providers';
3680
+ };
3681
+ export type ListAuthProvidersErrors = {
3682
+ /**
3683
+ * Internal server error
3684
+ */
3685
+ 500: ErrorResponse;
3686
+ };
3687
+ export type ListAuthProvidersError = ListAuthProvidersErrors[keyof ListAuthProvidersErrors];
3688
+ export type ListAuthProvidersResponses = {
3689
+ /**
3690
+ * Enabled providers listed successfully
3691
+ */
3692
+ 200: ProvidersResponse;
3693
+ };
3694
+ export type ListAuthProvidersResponse = ListAuthProvidersResponses[keyof ListAuthProvidersResponses];
3601
3695
  export type AuthCallbackData = {
3602
3696
  body?: never;
3603
3697
  path?: never;
3604
3698
  query: {
3605
3699
  /**
3606
- * Authorization code returned by WorkOS after user authentication
3700
+ * Authorization code returned by the identity provider after user authentication
3607
3701
  */
3608
3702
  code: string;
3609
3703
  /**
@@ -3623,7 +3717,7 @@ export type AuthCallbackErrors = {
3623
3717
  */
3624
3718
  401: ErrorResponse;
3625
3719
  /**
3626
- * WorkOS authentication failed or session could not be created
3720
+ * Identity provider authentication failed or session could not be created
3627
3721
  */
3628
3722
  500: ErrorResponse;
3629
3723
  };
@@ -9839,9 +9933,14 @@ export type DeleteTypeResponses = {
9839
9933
  export type DeleteTypeResponse = DeleteTypeResponses[keyof DeleteTypeResponses];
9840
9934
  export type ListEmbeddingProvidersData = {
9841
9935
  body?: never;
9842
- path?: never;
9936
+ path: {
9937
+ /**
9938
+ * Team that owns the embedding provider(s).
9939
+ */
9940
+ team_id: string;
9941
+ };
9843
9942
  query?: never;
9844
- url: '/api/v1/embedding-providers';
9943
+ url: '/api/v1/{team_id}/embedding-providers';
9845
9944
  };
9846
9945
  export type ListEmbeddingProvidersErrors = {
9847
9946
  /**
@@ -9863,9 +9962,14 @@ export type ListEmbeddingProvidersResponses = {
9863
9962
  export type ListEmbeddingProvidersResponse = ListEmbeddingProvidersResponses[keyof ListEmbeddingProvidersResponses];
9864
9963
  export type CreateEmbeddingProviderData = {
9865
9964
  body: CreateEmbeddingProviderRequest;
9866
- path?: never;
9965
+ path: {
9966
+ /**
9967
+ * Team that owns the embedding provider(s).
9968
+ */
9969
+ team_id: string;
9970
+ };
9867
9971
  query?: never;
9868
- url: '/api/v1/embedding-providers';
9972
+ url: '/api/v1/{team_id}/embedding-providers';
9869
9973
  };
9870
9974
  export type CreateEmbeddingProviderErrors = {
9871
9975
  /**
@@ -9896,13 +10000,17 @@ export type CreateEmbeddingProviderResponse = CreateEmbeddingProviderResponses[k
9896
10000
  export type DeleteEmbeddingProviderData = {
9897
10001
  body?: never;
9898
10002
  path: {
10003
+ /**
10004
+ * Team that owns the embedding provider(s).
10005
+ */
10006
+ team_id: string;
9899
10007
  /**
9900
10008
  * Embedding provider ID
9901
10009
  */
9902
10010
  id: string;
9903
10011
  };
9904
10012
  query?: never;
9905
- url: '/api/v1/embedding-providers/{id}';
10013
+ url: '/api/v1/{team_id}/embedding-providers/{id}';
9906
10014
  };
9907
10015
  export type DeleteEmbeddingProviderErrors = {
9908
10016
  /**
@@ -9933,13 +10041,17 @@ export type DeleteEmbeddingProviderResponse = DeleteEmbeddingProviderResponses[k
9933
10041
  export type GetEmbeddingProviderData = {
9934
10042
  body?: never;
9935
10043
  path: {
10044
+ /**
10045
+ * Team that owns the embedding provider(s).
10046
+ */
10047
+ team_id: string;
9936
10048
  /**
9937
10049
  * Embedding provider ID
9938
10050
  */
9939
10051
  id: string;
9940
10052
  };
9941
10053
  query?: never;
9942
- url: '/api/v1/embedding-providers/{id}';
10054
+ url: '/api/v1/{team_id}/embedding-providers/{id}';
9943
10055
  };
9944
10056
  export type GetEmbeddingProviderErrors = {
9945
10057
  /**
@@ -9966,13 +10078,17 @@ export type GetEmbeddingProviderResponse = GetEmbeddingProviderResponses[keyof G
9966
10078
  export type UpdateEmbeddingProviderData = {
9967
10079
  body: UpdateEmbeddingProviderRequest;
9968
10080
  path: {
10081
+ /**
10082
+ * Team that owns the embedding provider(s).
10083
+ */
10084
+ team_id: string;
9969
10085
  /**
9970
10086
  * Embedding provider ID
9971
10087
  */
9972
10088
  id: string;
9973
10089
  };
9974
10090
  query?: never;
9975
- url: '/api/v1/embedding-providers/{id}';
10091
+ url: '/api/v1/{team_id}/embedding-providers/{id}';
9976
10092
  };
9977
10093
  export type UpdateEmbeddingProviderErrors = {
9978
10094
  /**
@@ -10002,9 +10118,14 @@ export type UpdateEmbeddingProviderResponses = {
10002
10118
  export type UpdateEmbeddingProviderResponse = UpdateEmbeddingProviderResponses[keyof UpdateEmbeddingProviderResponses];
10003
10119
  export type ValidateEmbeddingProviderData = {
10004
10120
  body: ValidateEmbeddingProviderRequest;
10005
- path?: never;
10121
+ path: {
10122
+ /**
10123
+ * Team that owns the embedding provider(s).
10124
+ */
10125
+ team_id: string;
10126
+ };
10006
10127
  query?: never;
10007
- url: '/api/v1/embedding-providers/validate';
10128
+ url: '/api/v1/{team_id}/embedding-providers/validate';
10008
10129
  };
10009
10130
  export type ValidateEmbeddingProviderErrors = {
10010
10131
  /**
@@ -10030,9 +10151,14 @@ export type ValidateEmbeddingProviderResponses = {
10030
10151
  export type ValidateEmbeddingProviderResponse2 = ValidateEmbeddingProviderResponses[keyof ValidateEmbeddingProviderResponses];
10031
10152
  export type ListEmbeddingProvidersSettingsData = {
10032
10153
  body?: never;
10033
- path?: never;
10154
+ path: {
10155
+ /**
10156
+ * Team that owns the embedding provider(s).
10157
+ */
10158
+ team_id: string;
10159
+ };
10034
10160
  query?: never;
10035
- url: '/api/v1/settings/embedding-providers';
10161
+ url: '/api/v1/{team_id}/settings/embedding-providers';
10036
10162
  };
10037
10163
  export type ListEmbeddingProvidersSettingsErrors = {
10038
10164
  /**
@@ -10054,9 +10180,14 @@ export type ListEmbeddingProvidersSettingsResponses = {
10054
10180
  export type ListEmbeddingProvidersSettingsResponse = ListEmbeddingProvidersSettingsResponses[keyof ListEmbeddingProvidersSettingsResponses];
10055
10181
  export type CreateEmbeddingProviderSettingsData = {
10056
10182
  body: CreateEmbeddingProviderRequest;
10057
- path?: never;
10183
+ path: {
10184
+ /**
10185
+ * Team that owns the embedding provider(s).
10186
+ */
10187
+ team_id: string;
10188
+ };
10058
10189
  query?: never;
10059
- url: '/api/v1/settings/embedding-providers';
10190
+ url: '/api/v1/{team_id}/settings/embedding-providers';
10060
10191
  };
10061
10192
  export type CreateEmbeddingProviderSettingsErrors = {
10062
10193
  /**
@@ -10087,13 +10218,17 @@ export type CreateEmbeddingProviderSettingsResponse = CreateEmbeddingProviderSet
10087
10218
  export type DeleteEmbeddingProviderSettingsData = {
10088
10219
  body?: never;
10089
10220
  path: {
10221
+ /**
10222
+ * Team that owns the embedding provider(s).
10223
+ */
10224
+ team_id: string;
10090
10225
  /**
10091
10226
  * Embedding provider ID
10092
10227
  */
10093
10228
  id: string;
10094
10229
  };
10095
10230
  query?: never;
10096
- url: '/api/v1/settings/embedding-providers/{id}';
10231
+ url: '/api/v1/{team_id}/settings/embedding-providers/{id}';
10097
10232
  };
10098
10233
  export type DeleteEmbeddingProviderSettingsErrors = {
10099
10234
  /**
@@ -10124,13 +10259,17 @@ export type DeleteEmbeddingProviderSettingsResponse = DeleteEmbeddingProviderSet
10124
10259
  export type GetEmbeddingProviderSettingsData = {
10125
10260
  body?: never;
10126
10261
  path: {
10262
+ /**
10263
+ * Team that owns the embedding provider(s).
10264
+ */
10265
+ team_id: string;
10127
10266
  /**
10128
10267
  * Embedding provider ID
10129
10268
  */
10130
10269
  id: string;
10131
10270
  };
10132
10271
  query?: never;
10133
- url: '/api/v1/settings/embedding-providers/{id}';
10272
+ url: '/api/v1/{team_id}/settings/embedding-providers/{id}';
10134
10273
  };
10135
10274
  export type GetEmbeddingProviderSettingsErrors = {
10136
10275
  /**
@@ -10157,13 +10296,17 @@ export type GetEmbeddingProviderSettingsResponse = GetEmbeddingProviderSettingsR
10157
10296
  export type UpdateEmbeddingProviderSettingsData = {
10158
10297
  body: UpdateEmbeddingProviderRequest;
10159
10298
  path: {
10299
+ /**
10300
+ * Team that owns the embedding provider(s).
10301
+ */
10302
+ team_id: string;
10160
10303
  /**
10161
10304
  * Embedding provider ID
10162
10305
  */
10163
10306
  id: string;
10164
10307
  };
10165
10308
  query?: never;
10166
- url: '/api/v1/settings/embedding-providers/{id}';
10309
+ url: '/api/v1/{team_id}/settings/embedding-providers/{id}';
10167
10310
  };
10168
10311
  export type UpdateEmbeddingProviderSettingsErrors = {
10169
10312
  /**
@@ -10193,9 +10336,14 @@ export type UpdateEmbeddingProviderSettingsResponses = {
10193
10336
  export type UpdateEmbeddingProviderSettingsResponse = UpdateEmbeddingProviderSettingsResponses[keyof UpdateEmbeddingProviderSettingsResponses];
10194
10337
  export type ValidateEmbeddingProviderSettingsData = {
10195
10338
  body: ValidateEmbeddingProviderRequest;
10196
- path?: never;
10339
+ path: {
10340
+ /**
10341
+ * Team that owns the embedding provider(s).
10342
+ */
10343
+ team_id: string;
10344
+ };
10197
10345
  query?: never;
10198
- url: '/api/v1/settings/embedding-providers/validate';
10346
+ url: '/api/v1/{team_id}/settings/embedding-providers/validate';
10199
10347
  };
10200
10348
  export type ValidateEmbeddingProviderSettingsErrors = {
10201
10349
  /**
@@ -10924,40 +11072,6 @@ export type CompleteOnboardingResponses = {
10924
11072
  200: User;
10925
11073
  };
10926
11074
  export type CompleteOnboardingResponse = CompleteOnboardingResponses[keyof CompleteOnboardingResponses];
10927
- export type SendContactMessageData = {
10928
- body: ContactFormRequest;
10929
- path?: never;
10930
- query?: never;
10931
- url: '/api/v1/website/contact/send-message';
10932
- };
10933
- export type SendContactMessageErrors = {
10934
- /**
10935
- * Validation failed (JSON body with `success: false`) or malformed JSON
10936
- * (plain-text "Invalid JSON format")
10937
- *
10938
- */
10939
- 400: ContactFormResponse;
10940
- /**
10941
- * Request body exceeds the 64 KB size limit (plain-text body)
10942
- */
10943
- 413: string;
10944
- /**
10945
- * Per-IP rate limit exceeded (plain-text body)
10946
- */
10947
- 429: string;
10948
- /**
10949
- * Failed to send message via the email provider (JSON body with `success` false)
10950
- */
10951
- 500: ContactFormResponse;
10952
- };
10953
- export type SendContactMessageError = SendContactMessageErrors[keyof SendContactMessageErrors];
10954
- export type SendContactMessageResponses = {
10955
- /**
10956
- * Message sent successfully
10957
- */
10958
- 200: ContactFormResponse;
10959
- };
10960
- export type SendContactMessageResponse = SendContactMessageResponses[keyof SendContactMessageResponses];
10961
11075
  export type ListFeedItemRepliesData = {
10962
11076
  body?: never;
10963
11077
  path: {