@vibexp/api-client 0.6.0 → 0.8.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/types.gen.d.ts +43 -37
- package/dist/schema.d.ts +48 -54
- package/package.json +1 -1
|
@@ -1038,9 +1038,9 @@ export type Artifact = {
|
|
|
1038
1038
|
*/
|
|
1039
1039
|
description?: string;
|
|
1040
1040
|
/**
|
|
1041
|
-
* Type category of the artifact
|
|
1041
|
+
* Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
1042
1042
|
*/
|
|
1043
|
-
type:
|
|
1043
|
+
type: string;
|
|
1044
1044
|
/**
|
|
1045
1045
|
* Additional metadata as key-value pairs
|
|
1046
1046
|
*/
|
|
@@ -1070,9 +1070,9 @@ export type CreateArtifactRequest = {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
description?: string;
|
|
1072
1072
|
/**
|
|
1073
|
-
* Type category of the artifact
|
|
1073
|
+
* Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. Defaults to general when omitted.
|
|
1074
1074
|
*/
|
|
1075
|
-
type?:
|
|
1075
|
+
type?: string;
|
|
1076
1076
|
/**
|
|
1077
1077
|
* Initial status of the artifact
|
|
1078
1078
|
*/
|
|
@@ -1106,9 +1106,9 @@ export type UpdateArtifactRequest = {
|
|
|
1106
1106
|
*/
|
|
1107
1107
|
description?: string;
|
|
1108
1108
|
/**
|
|
1109
|
-
* Updated type category of the artifact
|
|
1109
|
+
* Updated type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
1110
1110
|
*/
|
|
1111
|
-
type?:
|
|
1111
|
+
type?: string;
|
|
1112
1112
|
/**
|
|
1113
1113
|
* Updated status of the artifact
|
|
1114
1114
|
*/
|
|
@@ -1627,6 +1627,10 @@ export type Memory = {
|
|
|
1627
1627
|
version: number;
|
|
1628
1628
|
};
|
|
1629
1629
|
export type CreateMemoryRequest = {
|
|
1630
|
+
/**
|
|
1631
|
+
* UUID of the project this memory belongs to
|
|
1632
|
+
*/
|
|
1633
|
+
project_id: string;
|
|
1630
1634
|
/**
|
|
1631
1635
|
* The text content of the memory
|
|
1632
1636
|
*/
|
|
@@ -1643,6 +1647,10 @@ export type CreateMemoryRequest = {
|
|
|
1643
1647
|
};
|
|
1644
1648
|
};
|
|
1645
1649
|
export type UpdateMemoryRequest = {
|
|
1650
|
+
/**
|
|
1651
|
+
* New project UUID for the memory (moves it between projects)
|
|
1652
|
+
*/
|
|
1653
|
+
project_id?: string;
|
|
1646
1654
|
/**
|
|
1647
1655
|
* Updated text content of the memory
|
|
1648
1656
|
*/
|
|
@@ -1912,7 +1920,7 @@ export type BlueprintListResponse = {
|
|
|
1912
1920
|
/**
|
|
1913
1921
|
* List of spec libraries
|
|
1914
1922
|
*/
|
|
1915
|
-
|
|
1923
|
+
blueprints: Array<Blueprint>;
|
|
1916
1924
|
/**
|
|
1917
1925
|
* Total number of spec libraries matching the filter criteria
|
|
1918
1926
|
*/
|
|
@@ -1971,35 +1979,21 @@ export type GitHubInstallationStatus = {
|
|
|
1971
1979
|
*/
|
|
1972
1980
|
installed: boolean;
|
|
1973
1981
|
/**
|
|
1974
|
-
* GitHub
|
|
1975
|
-
*/
|
|
1976
|
-
installation_id?: number;
|
|
1977
|
-
/**
|
|
1978
|
-
* GitHub account or organization login that installed the app
|
|
1982
|
+
* GitHub account or organization login that installed the app (present when installed is true)
|
|
1979
1983
|
*/
|
|
1980
1984
|
account_login?: string;
|
|
1981
1985
|
/**
|
|
1982
|
-
*
|
|
1983
|
-
*/
|
|
1984
|
-
account_type?: 'User' | 'Organization';
|
|
1985
|
-
/**
|
|
1986
|
-
* Target type of the installation
|
|
1987
|
-
*/
|
|
1988
|
-
target_type?: string;
|
|
1989
|
-
/**
|
|
1990
|
-
* Permissions granted by the installation
|
|
1986
|
+
* GitHub installation ID (present when installed is true)
|
|
1991
1987
|
*/
|
|
1992
|
-
|
|
1993
|
-
[key: string]: string;
|
|
1994
|
-
};
|
|
1988
|
+
installation_id?: number;
|
|
1995
1989
|
/**
|
|
1996
|
-
*
|
|
1990
|
+
* Whether the installation is currently suspended
|
|
1997
1991
|
*/
|
|
1998
|
-
|
|
1992
|
+
suspended?: boolean;
|
|
1999
1993
|
/**
|
|
2000
|
-
* When the
|
|
1994
|
+
* When the GitHub App was installed (present when installed is true)
|
|
2001
1995
|
*/
|
|
2002
|
-
|
|
1996
|
+
installed_at?: string;
|
|
2003
1997
|
};
|
|
2004
1998
|
/**
|
|
2005
1999
|
* A GitHub repository accessible by the installation
|
|
@@ -2164,7 +2158,7 @@ export type BlueprintImportReport = {
|
|
|
2164
2158
|
/**
|
|
2165
2159
|
* Details of files successfully imported
|
|
2166
2160
|
*/
|
|
2167
|
-
|
|
2161
|
+
successful_items: Array<BlueprintImportSuccess>;
|
|
2168
2162
|
/**
|
|
2169
2163
|
* Details of files that were skipped
|
|
2170
2164
|
*/
|
|
@@ -4044,9 +4038,9 @@ export type ListArtifactsData = {
|
|
|
4044
4038
|
*/
|
|
4045
4039
|
status?: 'active' | 'draft' | 'archived';
|
|
4046
4040
|
/**
|
|
4047
|
-
* Filter by type
|
|
4041
|
+
* Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
4048
4042
|
*/
|
|
4049
|
-
type?:
|
|
4043
|
+
type?: string;
|
|
4050
4044
|
/**
|
|
4051
4045
|
* Search in title, description, and content
|
|
4052
4046
|
*/
|
|
@@ -4172,9 +4166,9 @@ export type ListArtifactsByProjectData = {
|
|
|
4172
4166
|
*/
|
|
4173
4167
|
status?: 'active' | 'draft' | 'archived';
|
|
4174
4168
|
/**
|
|
4175
|
-
* Filter by type
|
|
4169
|
+
* Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
4176
4170
|
*/
|
|
4177
|
-
type?:
|
|
4171
|
+
type?: string;
|
|
4178
4172
|
/**
|
|
4179
4173
|
* Search in title, description, and content
|
|
4180
4174
|
*/
|
|
@@ -4937,6 +4931,10 @@ export type ListMemoriesData = {
|
|
|
4937
4931
|
team_id: string;
|
|
4938
4932
|
};
|
|
4939
4933
|
query?: {
|
|
4934
|
+
/**
|
|
4935
|
+
* Filter memories by project ID
|
|
4936
|
+
*/
|
|
4937
|
+
project_id?: string;
|
|
4940
4938
|
/**
|
|
4941
4939
|
* Search in memory text
|
|
4942
4940
|
*/
|
|
@@ -5024,6 +5022,10 @@ export type SearchMemoriesByMetadataData = {
|
|
|
5024
5022
|
team_id: string;
|
|
5025
5023
|
};
|
|
5026
5024
|
query: {
|
|
5025
|
+
/**
|
|
5026
|
+
* Filter memories by project ID
|
|
5027
|
+
*/
|
|
5028
|
+
project_id?: string;
|
|
5027
5029
|
/**
|
|
5028
5030
|
* Metadata key to search for
|
|
5029
5031
|
*/
|
|
@@ -6851,6 +6853,10 @@ export type HandleGitHubCallbackData = {
|
|
|
6851
6853
|
* GitHub App installation ID from the callback URL
|
|
6852
6854
|
*/
|
|
6853
6855
|
installation_id: number;
|
|
6856
|
+
/**
|
|
6857
|
+
* Setup action reported by GitHub on the callback URL (e.g. "install"). Accepted for forward compatibility but currently ignored server-side.
|
|
6858
|
+
*/
|
|
6859
|
+
setup_action?: string;
|
|
6854
6860
|
/**
|
|
6855
6861
|
* HMAC-signed state parameter from the install URL (CSRF protection)
|
|
6856
6862
|
*/
|
|
@@ -6980,16 +6986,16 @@ export type ImportGitHubProjectResponses = {
|
|
|
6980
6986
|
* Project already exists — returned without creating a new one
|
|
6981
6987
|
*/
|
|
6982
6988
|
200: {
|
|
6983
|
-
project
|
|
6984
|
-
created
|
|
6989
|
+
project: Project;
|
|
6990
|
+
created: boolean;
|
|
6985
6991
|
message?: string;
|
|
6986
6992
|
};
|
|
6987
6993
|
/**
|
|
6988
6994
|
* Project created successfully from the GitHub repository
|
|
6989
6995
|
*/
|
|
6990
6996
|
201: {
|
|
6991
|
-
project
|
|
6992
|
-
created
|
|
6997
|
+
project: Project;
|
|
6998
|
+
created: boolean;
|
|
6993
6999
|
};
|
|
6994
7000
|
};
|
|
6995
7001
|
export type ImportGitHubProjectResponse = ImportGitHubProjectResponses[keyof ImportGitHubProjectResponses];
|
package/dist/schema.d.ts
CHANGED
|
@@ -4586,11 +4586,10 @@ export interface components {
|
|
|
4586
4586
|
*/
|
|
4587
4587
|
description?: string;
|
|
4588
4588
|
/**
|
|
4589
|
-
* @description Type category of the artifact
|
|
4589
|
+
* @description Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
4590
4590
|
* @example general
|
|
4591
|
-
* @enum {string}
|
|
4592
4591
|
*/
|
|
4593
|
-
type:
|
|
4592
|
+
type: string;
|
|
4594
4593
|
/**
|
|
4595
4594
|
* @description Additional metadata as key-value pairs
|
|
4596
4595
|
* @example {
|
|
@@ -4633,11 +4632,10 @@ export interface components {
|
|
|
4633
4632
|
*/
|
|
4634
4633
|
description?: string;
|
|
4635
4634
|
/**
|
|
4636
|
-
* @description Type category of the artifact
|
|
4635
|
+
* @description Type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. Defaults to general when omitted.
|
|
4637
4636
|
* @example general
|
|
4638
|
-
* @enum {string}
|
|
4639
4637
|
*/
|
|
4640
|
-
type?:
|
|
4638
|
+
type?: string;
|
|
4641
4639
|
/**
|
|
4642
4640
|
* @description Initial status of the artifact
|
|
4643
4641
|
* @example active
|
|
@@ -4686,11 +4684,10 @@ export interface components {
|
|
|
4686
4684
|
*/
|
|
4687
4685
|
description?: string;
|
|
4688
4686
|
/**
|
|
4689
|
-
* @description Updated type category of the artifact
|
|
4687
|
+
* @description Updated type category of the artifact. An open string validated at runtime against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum.
|
|
4690
4688
|
* @example general
|
|
4691
|
-
* @enum {string}
|
|
4692
4689
|
*/
|
|
4693
|
-
type?:
|
|
4690
|
+
type?: string;
|
|
4694
4691
|
/**
|
|
4695
4692
|
* @description Updated status of the artifact
|
|
4696
4693
|
* @example active
|
|
@@ -5370,6 +5367,12 @@ export interface components {
|
|
|
5370
5367
|
version: number;
|
|
5371
5368
|
};
|
|
5372
5369
|
CreateMemoryRequest: {
|
|
5370
|
+
/**
|
|
5371
|
+
* Format: uuid
|
|
5372
|
+
* @description UUID of the project this memory belongs to
|
|
5373
|
+
* @example 01234567-89ab-cdef-0123-456789abcdef
|
|
5374
|
+
*/
|
|
5375
|
+
project_id: string;
|
|
5373
5376
|
/**
|
|
5374
5377
|
* @description The text content of the memory
|
|
5375
5378
|
* @example Remember to update the API documentation when adding new endpoints
|
|
@@ -5394,6 +5397,12 @@ export interface components {
|
|
|
5394
5397
|
};
|
|
5395
5398
|
};
|
|
5396
5399
|
UpdateMemoryRequest: {
|
|
5400
|
+
/**
|
|
5401
|
+
* Format: uuid
|
|
5402
|
+
* @description New project UUID for the memory (moves it between projects)
|
|
5403
|
+
* @example 01234567-89ab-cdef-0123-456789abcdef
|
|
5404
|
+
*/
|
|
5405
|
+
project_id?: string;
|
|
5397
5406
|
/**
|
|
5398
5407
|
* @description Updated text content of the memory
|
|
5399
5408
|
* @example Updated reminder to include versioning in API documentation
|
|
@@ -5774,7 +5783,7 @@ export interface components {
|
|
|
5774
5783
|
};
|
|
5775
5784
|
BlueprintListResponse: {
|
|
5776
5785
|
/** @description List of spec libraries */
|
|
5777
|
-
|
|
5786
|
+
blueprints: components["schemas"]["Blueprint"][];
|
|
5778
5787
|
/**
|
|
5779
5788
|
* @description Total number of spec libraries matching the filter criteria
|
|
5780
5789
|
* @example 42
|
|
@@ -5844,51 +5853,27 @@ export interface components {
|
|
|
5844
5853
|
*/
|
|
5845
5854
|
installed: boolean;
|
|
5846
5855
|
/**
|
|
5847
|
-
*
|
|
5848
|
-
* @description GitHub installation ID (present when installed is true)
|
|
5849
|
-
* @example 12345678
|
|
5850
|
-
*/
|
|
5851
|
-
installation_id?: number;
|
|
5852
|
-
/**
|
|
5853
|
-
* @description GitHub account or organization login that installed the app
|
|
5856
|
+
* @description GitHub account or organization login that installed the app (present when installed is true)
|
|
5854
5857
|
* @example my-org
|
|
5855
5858
|
*/
|
|
5856
5859
|
account_login?: string;
|
|
5857
5860
|
/**
|
|
5858
|
-
*
|
|
5859
|
-
* @
|
|
5860
|
-
* @
|
|
5861
|
-
*/
|
|
5862
|
-
account_type?: "User" | "Organization";
|
|
5863
|
-
/**
|
|
5864
|
-
* @description Target type of the installation
|
|
5865
|
-
* @example Organization
|
|
5866
|
-
*/
|
|
5867
|
-
target_type?: string;
|
|
5868
|
-
/**
|
|
5869
|
-
* @description Permissions granted by the installation
|
|
5870
|
-
* @example {
|
|
5871
|
-
* "contents": "read",
|
|
5872
|
-
* "metadata": "read"
|
|
5873
|
-
* }
|
|
5861
|
+
* Format: int64
|
|
5862
|
+
* @description GitHub installation ID (present when installed is true)
|
|
5863
|
+
* @example 12345678
|
|
5874
5864
|
*/
|
|
5875
|
-
|
|
5876
|
-
[key: string]: string;
|
|
5877
|
-
};
|
|
5865
|
+
installation_id?: number;
|
|
5878
5866
|
/**
|
|
5879
|
-
* @description
|
|
5880
|
-
* @example
|
|
5881
|
-
* "push",
|
|
5882
|
-
* "pull_request"
|
|
5883
|
-
* ]
|
|
5867
|
+
* @description Whether the installation is currently suspended
|
|
5868
|
+
* @example false
|
|
5884
5869
|
*/
|
|
5885
|
-
|
|
5870
|
+
suspended?: boolean;
|
|
5886
5871
|
/**
|
|
5887
5872
|
* Format: date-time
|
|
5888
|
-
* @description When the
|
|
5889
|
-
* @example
|
|
5873
|
+
* @description When the GitHub App was installed (present when installed is true)
|
|
5874
|
+
* @example 2024-01-15T10:30:00Z
|
|
5890
5875
|
*/
|
|
5891
|
-
|
|
5876
|
+
installed_at?: string;
|
|
5892
5877
|
};
|
|
5893
5878
|
/** @description A GitHub repository accessible by the installation */
|
|
5894
5879
|
GitHubRepository: {
|
|
@@ -6058,7 +6043,7 @@ export interface components {
|
|
|
6058
6043
|
/** @description Details of files that failed to import */
|
|
6059
6044
|
failed_items: components["schemas"]["BlueprintImportFailed"][];
|
|
6060
6045
|
/** @description Details of files successfully imported */
|
|
6061
|
-
|
|
6046
|
+
successful_items: components["schemas"]["BlueprintImportSuccess"][];
|
|
6062
6047
|
/** @description Details of files that were skipped */
|
|
6063
6048
|
skipped_items: components["schemas"]["BlueprintImportSkipped"][];
|
|
6064
6049
|
};
|
|
@@ -8384,8 +8369,8 @@ export interface operations {
|
|
|
8384
8369
|
project_id?: string;
|
|
8385
8370
|
/** @description Filter by status */
|
|
8386
8371
|
status?: "active" | "draft" | "archived";
|
|
8387
|
-
/** @description Filter by type */
|
|
8388
|
-
type?:
|
|
8372
|
+
/** @description Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. */
|
|
8373
|
+
type?: string;
|
|
8389
8374
|
/** @description Search in title, description, and content */
|
|
8390
8375
|
search?: string;
|
|
8391
8376
|
/** @description Sort field */
|
|
@@ -8544,8 +8529,8 @@ export interface operations {
|
|
|
8544
8529
|
query?: {
|
|
8545
8530
|
/** @description Filter by status */
|
|
8546
8531
|
status?: "active" | "draft" | "archived";
|
|
8547
|
-
/** @description Filter by type */
|
|
8548
|
-
type?:
|
|
8532
|
+
/** @description Filter by type. An open string matched against the team's registered types (the system defaults work_reports, static_contexts and general, plus any custom types the team has added), not a fixed enum. */
|
|
8533
|
+
type?: string;
|
|
8549
8534
|
/** @description Search in title, description, and content */
|
|
8550
8535
|
search?: string;
|
|
8551
8536
|
/** @description Sort field */
|
|
@@ -9586,6 +9571,8 @@ export interface operations {
|
|
|
9586
9571
|
listMemories: {
|
|
9587
9572
|
parameters: {
|
|
9588
9573
|
query?: {
|
|
9574
|
+
/** @description Filter memories by project ID */
|
|
9575
|
+
project_id?: string;
|
|
9589
9576
|
/** @description Search in memory text */
|
|
9590
9577
|
search?: string;
|
|
9591
9578
|
/** @description Filter by metadata key */
|
|
@@ -9680,6 +9667,8 @@ export interface operations {
|
|
|
9680
9667
|
searchMemoriesByMetadata: {
|
|
9681
9668
|
parameters: {
|
|
9682
9669
|
query: {
|
|
9670
|
+
/** @description Filter memories by project ID */
|
|
9671
|
+
project_id?: string;
|
|
9683
9672
|
/** @description Metadata key to search for */
|
|
9684
9673
|
metadata_key: string;
|
|
9685
9674
|
/** @description Metadata value to search for */
|
|
@@ -12204,6 +12193,11 @@ export interface operations {
|
|
|
12204
12193
|
* @example 12345678
|
|
12205
12194
|
*/
|
|
12206
12195
|
installation_id: number;
|
|
12196
|
+
/**
|
|
12197
|
+
* @description Setup action reported by GitHub on the callback URL (e.g. "install"). Accepted for forward compatibility but currently ignored server-side.
|
|
12198
|
+
* @example install
|
|
12199
|
+
*/
|
|
12200
|
+
setup_action?: string;
|
|
12207
12201
|
/**
|
|
12208
12202
|
* @description HMAC-signed state parameter from the install URL (CSRF protection)
|
|
12209
12203
|
* @example team-id:1234567890:signature
|
|
@@ -12352,9 +12346,9 @@ export interface operations {
|
|
|
12352
12346
|
};
|
|
12353
12347
|
content: {
|
|
12354
12348
|
"application/json": {
|
|
12355
|
-
project
|
|
12349
|
+
project: components["schemas"]["Project"];
|
|
12356
12350
|
/** @example false */
|
|
12357
|
-
created
|
|
12351
|
+
created: boolean;
|
|
12358
12352
|
/** @example Project already exists for this repository */
|
|
12359
12353
|
message?: string;
|
|
12360
12354
|
};
|
|
@@ -12367,9 +12361,9 @@ export interface operations {
|
|
|
12367
12361
|
};
|
|
12368
12362
|
content: {
|
|
12369
12363
|
"application/json": {
|
|
12370
|
-
project
|
|
12364
|
+
project: components["schemas"]["Project"];
|
|
12371
12365
|
/** @example true */
|
|
12372
|
-
created
|
|
12366
|
+
created: boolean;
|
|
12373
12367
|
};
|
|
12374
12368
|
};
|
|
12375
12369
|
};
|
package/package.json
CHANGED