@arke-institute/sdk 2.3.1 → 2.3.2
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/generated/index.d.cts +78 -1
- package/dist/generated/index.d.ts +78 -1
- package/openapi/spec.json +77 -0
- package/openapi/version.json +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-04T16:48:55.356Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -2042,6 +2042,76 @@ type paths = {
|
|
|
2042
2042
|
patch?: never;
|
|
2043
2043
|
trace?: never;
|
|
2044
2044
|
};
|
|
2045
|
+
"/entities/{id}/collection": {
|
|
2046
|
+
parameters: {
|
|
2047
|
+
query?: never;
|
|
2048
|
+
header?: never;
|
|
2049
|
+
path?: never;
|
|
2050
|
+
cookie?: never;
|
|
2051
|
+
};
|
|
2052
|
+
/**
|
|
2053
|
+
* Get entity collection
|
|
2054
|
+
* @description Returns the collection ID that this entity belongs to. Returns null if the entity is not in any collection. If the entity IS a collection, returns its own ID.
|
|
2055
|
+
*/
|
|
2056
|
+
get: {
|
|
2057
|
+
parameters: {
|
|
2058
|
+
query?: never;
|
|
2059
|
+
header?: never;
|
|
2060
|
+
path: {
|
|
2061
|
+
/** @description Entity ID (ULID) */
|
|
2062
|
+
id: string;
|
|
2063
|
+
};
|
|
2064
|
+
cookie?: never;
|
|
2065
|
+
};
|
|
2066
|
+
requestBody?: never;
|
|
2067
|
+
responses: {
|
|
2068
|
+
/** @description Collection lookup result */
|
|
2069
|
+
200: {
|
|
2070
|
+
headers: {
|
|
2071
|
+
[name: string]: unknown;
|
|
2072
|
+
};
|
|
2073
|
+
content: {
|
|
2074
|
+
"application/json": components["schemas"]["EntityCollectionResponse"];
|
|
2075
|
+
};
|
|
2076
|
+
};
|
|
2077
|
+
/** @description Forbidden - Insufficient permissions */
|
|
2078
|
+
403: {
|
|
2079
|
+
headers: {
|
|
2080
|
+
[name: string]: unknown;
|
|
2081
|
+
};
|
|
2082
|
+
content: {
|
|
2083
|
+
/**
|
|
2084
|
+
* @example {
|
|
2085
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
2086
|
+
* }
|
|
2087
|
+
*/
|
|
2088
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2089
|
+
};
|
|
2090
|
+
};
|
|
2091
|
+
/** @description Not Found - Resource does not exist */
|
|
2092
|
+
404: {
|
|
2093
|
+
headers: {
|
|
2094
|
+
[name: string]: unknown;
|
|
2095
|
+
};
|
|
2096
|
+
content: {
|
|
2097
|
+
/**
|
|
2098
|
+
* @example {
|
|
2099
|
+
* "error": "Entity not found"
|
|
2100
|
+
* }
|
|
2101
|
+
*/
|
|
2102
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2103
|
+
};
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
};
|
|
2107
|
+
put?: never;
|
|
2108
|
+
post?: never;
|
|
2109
|
+
delete?: never;
|
|
2110
|
+
options?: never;
|
|
2111
|
+
head?: never;
|
|
2112
|
+
patch?: never;
|
|
2113
|
+
trace?: never;
|
|
2114
|
+
};
|
|
2045
2115
|
"/relationships": {
|
|
2046
2116
|
parameters: {
|
|
2047
2117
|
query?: never;
|
|
@@ -5784,6 +5854,13 @@ type components = {
|
|
|
5784
5854
|
*/
|
|
5785
5855
|
note?: string;
|
|
5786
5856
|
};
|
|
5857
|
+
EntityCollectionResponse: {
|
|
5858
|
+
/**
|
|
5859
|
+
* @description The collection ID this entity belongs to, or null if not in any collection
|
|
5860
|
+
* @example 01KDETYWYWM0MJVKM8DK3AEXPY
|
|
5861
|
+
*/
|
|
5862
|
+
collection_id: string | null;
|
|
5863
|
+
};
|
|
5787
5864
|
AddRelationshipResponse: {
|
|
5788
5865
|
source: components["schemas"]["EntityResponse"] & unknown;
|
|
5789
5866
|
target?: components["schemas"]["EntityResponse"] & unknown;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-04T16:48:55.356Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -2042,6 +2042,76 @@ type paths = {
|
|
|
2042
2042
|
patch?: never;
|
|
2043
2043
|
trace?: never;
|
|
2044
2044
|
};
|
|
2045
|
+
"/entities/{id}/collection": {
|
|
2046
|
+
parameters: {
|
|
2047
|
+
query?: never;
|
|
2048
|
+
header?: never;
|
|
2049
|
+
path?: never;
|
|
2050
|
+
cookie?: never;
|
|
2051
|
+
};
|
|
2052
|
+
/**
|
|
2053
|
+
* Get entity collection
|
|
2054
|
+
* @description Returns the collection ID that this entity belongs to. Returns null if the entity is not in any collection. If the entity IS a collection, returns its own ID.
|
|
2055
|
+
*/
|
|
2056
|
+
get: {
|
|
2057
|
+
parameters: {
|
|
2058
|
+
query?: never;
|
|
2059
|
+
header?: never;
|
|
2060
|
+
path: {
|
|
2061
|
+
/** @description Entity ID (ULID) */
|
|
2062
|
+
id: string;
|
|
2063
|
+
};
|
|
2064
|
+
cookie?: never;
|
|
2065
|
+
};
|
|
2066
|
+
requestBody?: never;
|
|
2067
|
+
responses: {
|
|
2068
|
+
/** @description Collection lookup result */
|
|
2069
|
+
200: {
|
|
2070
|
+
headers: {
|
|
2071
|
+
[name: string]: unknown;
|
|
2072
|
+
};
|
|
2073
|
+
content: {
|
|
2074
|
+
"application/json": components["schemas"]["EntityCollectionResponse"];
|
|
2075
|
+
};
|
|
2076
|
+
};
|
|
2077
|
+
/** @description Forbidden - Insufficient permissions */
|
|
2078
|
+
403: {
|
|
2079
|
+
headers: {
|
|
2080
|
+
[name: string]: unknown;
|
|
2081
|
+
};
|
|
2082
|
+
content: {
|
|
2083
|
+
/**
|
|
2084
|
+
* @example {
|
|
2085
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
2086
|
+
* }
|
|
2087
|
+
*/
|
|
2088
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2089
|
+
};
|
|
2090
|
+
};
|
|
2091
|
+
/** @description Not Found - Resource does not exist */
|
|
2092
|
+
404: {
|
|
2093
|
+
headers: {
|
|
2094
|
+
[name: string]: unknown;
|
|
2095
|
+
};
|
|
2096
|
+
content: {
|
|
2097
|
+
/**
|
|
2098
|
+
* @example {
|
|
2099
|
+
* "error": "Entity not found"
|
|
2100
|
+
* }
|
|
2101
|
+
*/
|
|
2102
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2103
|
+
};
|
|
2104
|
+
};
|
|
2105
|
+
};
|
|
2106
|
+
};
|
|
2107
|
+
put?: never;
|
|
2108
|
+
post?: never;
|
|
2109
|
+
delete?: never;
|
|
2110
|
+
options?: never;
|
|
2111
|
+
head?: never;
|
|
2112
|
+
patch?: never;
|
|
2113
|
+
trace?: never;
|
|
2114
|
+
};
|
|
2045
2115
|
"/relationships": {
|
|
2046
2116
|
parameters: {
|
|
2047
2117
|
query?: never;
|
|
@@ -5784,6 +5854,13 @@ type components = {
|
|
|
5784
5854
|
*/
|
|
5785
5855
|
note?: string;
|
|
5786
5856
|
};
|
|
5857
|
+
EntityCollectionResponse: {
|
|
5858
|
+
/**
|
|
5859
|
+
* @description The collection ID this entity belongs to, or null if not in any collection
|
|
5860
|
+
* @example 01KDETYWYWM0MJVKM8DK3AEXPY
|
|
5861
|
+
*/
|
|
5862
|
+
collection_id: string | null;
|
|
5863
|
+
};
|
|
5787
5864
|
AddRelationshipResponse: {
|
|
5788
5865
|
source: components["schemas"]["EntityResponse"] & unknown;
|
|
5789
5866
|
target?: components["schemas"]["EntityResponse"] & unknown;
|
package/openapi/spec.json
CHANGED
|
@@ -1802,6 +1802,20 @@
|
|
|
1802
1802
|
"expect_tip"
|
|
1803
1803
|
]
|
|
1804
1804
|
},
|
|
1805
|
+
"EntityCollectionResponse": {
|
|
1806
|
+
"type": "object",
|
|
1807
|
+
"properties": {
|
|
1808
|
+
"collection_id": {
|
|
1809
|
+
"type": "string",
|
|
1810
|
+
"nullable": true,
|
|
1811
|
+
"description": "The collection ID this entity belongs to, or null if not in any collection",
|
|
1812
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
1813
|
+
}
|
|
1814
|
+
},
|
|
1815
|
+
"required": [
|
|
1816
|
+
"collection_id"
|
|
1817
|
+
]
|
|
1818
|
+
},
|
|
1805
1819
|
"AddRelationshipResponse": {
|
|
1806
1820
|
"type": "object",
|
|
1807
1821
|
"properties": {
|
|
@@ -6525,6 +6539,69 @@
|
|
|
6525
6539
|
}
|
|
6526
6540
|
}
|
|
6527
6541
|
},
|
|
6542
|
+
"/entities/{id}/collection": {
|
|
6543
|
+
"get": {
|
|
6544
|
+
"tags": [
|
|
6545
|
+
"Entities"
|
|
6546
|
+
],
|
|
6547
|
+
"summary": "Get entity collection",
|
|
6548
|
+
"description": "Returns the collection ID that this entity belongs to. Returns null if the entity is not in any collection. If the entity IS a collection, returns its own ID.",
|
|
6549
|
+
"x-arke-action": "entity:view",
|
|
6550
|
+
"x-arke-auth": "optional",
|
|
6551
|
+
"parameters": [
|
|
6552
|
+
{
|
|
6553
|
+
"schema": {
|
|
6554
|
+
"type": "string",
|
|
6555
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
6556
|
+
"description": "Entity ID (ULID format)",
|
|
6557
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
6558
|
+
},
|
|
6559
|
+
"required": true,
|
|
6560
|
+
"description": "Entity ID (ULID)",
|
|
6561
|
+
"name": "id",
|
|
6562
|
+
"in": "path"
|
|
6563
|
+
}
|
|
6564
|
+
],
|
|
6565
|
+
"responses": {
|
|
6566
|
+
"200": {
|
|
6567
|
+
"description": "Collection lookup result",
|
|
6568
|
+
"content": {
|
|
6569
|
+
"application/json": {
|
|
6570
|
+
"schema": {
|
|
6571
|
+
"$ref": "#/components/schemas/EntityCollectionResponse"
|
|
6572
|
+
}
|
|
6573
|
+
}
|
|
6574
|
+
}
|
|
6575
|
+
},
|
|
6576
|
+
"403": {
|
|
6577
|
+
"description": "Forbidden - Insufficient permissions",
|
|
6578
|
+
"content": {
|
|
6579
|
+
"application/json": {
|
|
6580
|
+
"schema": {
|
|
6581
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
6582
|
+
},
|
|
6583
|
+
"example": {
|
|
6584
|
+
"error": "Forbidden: You do not have permission to perform this action"
|
|
6585
|
+
}
|
|
6586
|
+
}
|
|
6587
|
+
}
|
|
6588
|
+
},
|
|
6589
|
+
"404": {
|
|
6590
|
+
"description": "Not Found - Resource does not exist",
|
|
6591
|
+
"content": {
|
|
6592
|
+
"application/json": {
|
|
6593
|
+
"schema": {
|
|
6594
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
6595
|
+
},
|
|
6596
|
+
"example": {
|
|
6597
|
+
"error": "Entity not found"
|
|
6598
|
+
}
|
|
6599
|
+
}
|
|
6600
|
+
}
|
|
6601
|
+
}
|
|
6602
|
+
}
|
|
6603
|
+
}
|
|
6604
|
+
},
|
|
6528
6605
|
"/relationships": {
|
|
6529
6606
|
"post": {
|
|
6530
6607
|
"tags": [
|
package/openapi/version.json
CHANGED