@proveanything/smartlinks 1.9.12 → 1.9.14
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/api/claimSet.d.ts +58 -70
- package/dist/api/claimSet.js +98 -110
- package/dist/docs/API_SUMMARY.md +69 -29
- package/dist/openapi.yaml +126 -95
- package/dist/types/claimSet.d.ts +42 -0
- package/docs/API_SUMMARY.md +69 -29
- package/openapi.yaml +126 -95
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -1976,12 +1976,12 @@ paths:
|
|
|
1976
1976
|
application/json:
|
|
1977
1977
|
schema:
|
|
1978
1978
|
$ref: "#/components/schemas/BroadcastSendTestRequest"
|
|
1979
|
-
/admin/collection/{collectionId}/
|
|
1980
|
-
|
|
1979
|
+
/admin/collection/{collectionId}/claimSetd)}/assignClaims:
|
|
1980
|
+
post:
|
|
1981
1981
|
tags:
|
|
1982
1982
|
- claimSet
|
|
1983
|
-
summary:
|
|
1984
|
-
operationId:
|
|
1983
|
+
summary: Perform a tag query for a collection.
|
|
1984
|
+
operationId: claimSet_assignClaims
|
|
1985
1985
|
security:
|
|
1986
1986
|
- bearerAuth: []
|
|
1987
1987
|
parameters:
|
|
@@ -1995,20 +1995,25 @@ paths:
|
|
|
1995
1995
|
description: Success
|
|
1996
1996
|
content:
|
|
1997
1997
|
application/json:
|
|
1998
|
-
schema:
|
|
1999
|
-
type: array
|
|
2000
|
-
items: {}
|
|
1998
|
+
schema: {}
|
|
2001
1999
|
400:
|
|
2002
2000
|
description: Bad request
|
|
2003
2001
|
401:
|
|
2004
2002
|
description: Unauthorized
|
|
2005
2003
|
404:
|
|
2006
2004
|
description: Not found
|
|
2005
|
+
requestBody:
|
|
2006
|
+
required: true
|
|
2007
|
+
content:
|
|
2008
|
+
application/json:
|
|
2009
|
+
schema:
|
|
2010
|
+
$ref: "#/components/schemas/AssignClaimsRequest"
|
|
2011
|
+
/admin/collection/{collectionId}/claimSetd)}/makeClaim:
|
|
2007
2012
|
post:
|
|
2008
2013
|
tags:
|
|
2009
2014
|
- claimSet
|
|
2010
|
-
summary:
|
|
2011
|
-
operationId:
|
|
2015
|
+
summary: Get tag summary for a collection.
|
|
2016
|
+
operationId: claimSet_makeClaim
|
|
2012
2017
|
security:
|
|
2013
2018
|
- bearerAuth: []
|
|
2014
2019
|
parameters:
|
|
@@ -2029,11 +2034,12 @@ paths:
|
|
|
2029
2034
|
description: Unauthorized
|
|
2030
2035
|
404:
|
|
2031
2036
|
description: Not found
|
|
2032
|
-
|
|
2037
|
+
/admin/collection/{collectionId}/claimSetd)}/tagQuery:
|
|
2038
|
+
post:
|
|
2033
2039
|
tags:
|
|
2034
2040
|
- claimSet
|
|
2035
|
-
summary:
|
|
2036
|
-
operationId:
|
|
2041
|
+
summary: Get a report for a claim set (collection-scoped).
|
|
2042
|
+
operationId: claimSet_tagQuery
|
|
2037
2043
|
security:
|
|
2038
2044
|
- bearerAuth: []
|
|
2039
2045
|
parameters:
|
|
@@ -2054,12 +2060,12 @@ paths:
|
|
|
2054
2060
|
description: Unauthorized
|
|
2055
2061
|
404:
|
|
2056
2062
|
description: Not found
|
|
2057
|
-
/admin/collection/{collectionId}/
|
|
2058
|
-
|
|
2063
|
+
/admin/collection/{collectionId}/claimSetd)}/tagSummary:
|
|
2064
|
+
get:
|
|
2059
2065
|
tags:
|
|
2060
2066
|
- claimSet
|
|
2061
|
-
summary:
|
|
2062
|
-
operationId:
|
|
2067
|
+
summary: Get a report for a claim set (collection-scoped).
|
|
2068
|
+
operationId: claimSet_getTagSummary
|
|
2063
2069
|
security:
|
|
2064
2070
|
- bearerAuth: []
|
|
2065
2071
|
parameters:
|
|
@@ -2080,18 +2086,12 @@ paths:
|
|
|
2080
2086
|
description: Unauthorized
|
|
2081
2087
|
404:
|
|
2082
2088
|
description: Not found
|
|
2083
|
-
|
|
2084
|
-
required: true
|
|
2085
|
-
content:
|
|
2086
|
-
application/json:
|
|
2087
|
-
schema:
|
|
2088
|
-
$ref: "#/components/schemas/AssignClaimsRequest"
|
|
2089
|
-
/admin/collection/{collectionId}/claimSet/makeClaim:
|
|
2089
|
+
/admin/collection/{collectionId}/claimSetd)}/updateClaimData:
|
|
2090
2090
|
post:
|
|
2091
2091
|
tags:
|
|
2092
2092
|
- claimSet
|
|
2093
|
-
summary:
|
|
2094
|
-
operationId:
|
|
2093
|
+
summary: Make a claim against a claim set (collection-scoped).
|
|
2094
|
+
operationId: claimSet_updateClaimData
|
|
2095
2095
|
security:
|
|
2096
2096
|
- bearerAuth: []
|
|
2097
2097
|
parameters:
|
|
@@ -2112,12 +2112,18 @@ paths:
|
|
|
2112
2112
|
description: Unauthorized
|
|
2113
2113
|
404:
|
|
2114
2114
|
description: Not found
|
|
2115
|
-
|
|
2116
|
-
|
|
2115
|
+
requestBody:
|
|
2116
|
+
required: true
|
|
2117
|
+
content:
|
|
2118
|
+
application/json:
|
|
2119
|
+
schema:
|
|
2120
|
+
$ref: "#/components/schemas/UpdateClaimDataRequest"
|
|
2121
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}:
|
|
2122
|
+
get:
|
|
2117
2123
|
tags:
|
|
2118
2124
|
- claimSet
|
|
2119
|
-
summary:
|
|
2120
|
-
operationId:
|
|
2125
|
+
summary: Returns the base path for claim set endpoints.
|
|
2126
|
+
operationId: claimSet_get
|
|
2121
2127
|
security:
|
|
2122
2128
|
- bearerAuth: []
|
|
2123
2129
|
parameters:
|
|
@@ -2126,6 +2132,11 @@ paths:
|
|
|
2126
2132
|
required: true
|
|
2127
2133
|
schema:
|
|
2128
2134
|
type: string
|
|
2135
|
+
- name: claimSetId
|
|
2136
|
+
in: path
|
|
2137
|
+
required: true
|
|
2138
|
+
schema:
|
|
2139
|
+
type: string
|
|
2129
2140
|
responses:
|
|
2130
2141
|
200:
|
|
2131
2142
|
description: Success
|
|
@@ -2138,12 +2149,11 @@ paths:
|
|
|
2138
2149
|
description: Unauthorized
|
|
2139
2150
|
404:
|
|
2140
2151
|
description: Not found
|
|
2141
|
-
|
|
2142
|
-
get:
|
|
2152
|
+
put:
|
|
2143
2153
|
tags:
|
|
2144
2154
|
- claimSet
|
|
2145
|
-
summary:
|
|
2146
|
-
operationId:
|
|
2155
|
+
summary: Create a new claim set.
|
|
2156
|
+
operationId: claimSet_update
|
|
2147
2157
|
security:
|
|
2148
2158
|
- bearerAuth: []
|
|
2149
2159
|
parameters:
|
|
@@ -2152,6 +2162,11 @@ paths:
|
|
|
2152
2162
|
required: true
|
|
2153
2163
|
schema:
|
|
2154
2164
|
type: string
|
|
2165
|
+
- name: claimSetId
|
|
2166
|
+
in: path
|
|
2167
|
+
required: true
|
|
2168
|
+
schema:
|
|
2169
|
+
type: string
|
|
2155
2170
|
responses:
|
|
2156
2171
|
200:
|
|
2157
2172
|
description: Success
|
|
@@ -2164,12 +2179,11 @@ paths:
|
|
|
2164
2179
|
description: Unauthorized
|
|
2165
2180
|
404:
|
|
2166
2181
|
description: Not found
|
|
2167
|
-
|
|
2168
|
-
post:
|
|
2182
|
+
delete:
|
|
2169
2183
|
tags:
|
|
2170
2184
|
- claimSet
|
|
2171
|
-
summary: Update claim
|
|
2172
|
-
operationId:
|
|
2185
|
+
summary: Update a claim set.
|
|
2186
|
+
operationId: claimSet_remove
|
|
2173
2187
|
security:
|
|
2174
2188
|
- bearerAuth: []
|
|
2175
2189
|
parameters:
|
|
@@ -2178,6 +2192,11 @@ paths:
|
|
|
2178
2192
|
required: true
|
|
2179
2193
|
schema:
|
|
2180
2194
|
type: string
|
|
2195
|
+
- name: claimSetId
|
|
2196
|
+
in: path
|
|
2197
|
+
required: true
|
|
2198
|
+
schema:
|
|
2199
|
+
type: string
|
|
2181
2200
|
responses:
|
|
2182
2201
|
200:
|
|
2183
2202
|
description: Success
|
|
@@ -2190,18 +2209,12 @@ paths:
|
|
|
2190
2209
|
description: Unauthorized
|
|
2191
2210
|
404:
|
|
2192
2211
|
description: Not found
|
|
2193
|
-
|
|
2194
|
-
required: true
|
|
2195
|
-
content:
|
|
2196
|
-
application/json:
|
|
2197
|
-
schema:
|
|
2198
|
-
$ref: "#/components/schemas/UpdateClaimDataRequest"
|
|
2199
|
-
/admin/collection/{collectionId}/claimSet/{claimSetId}:
|
|
2212
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}/assignedTags:
|
|
2200
2213
|
get:
|
|
2201
2214
|
tags:
|
|
2202
2215
|
- claimSet
|
|
2203
|
-
summary: Get all
|
|
2204
|
-
operationId:
|
|
2216
|
+
summary: Get all tags for a claim set (including data).
|
|
2217
|
+
operationId: claimSet_getAssignedTags
|
|
2205
2218
|
security:
|
|
2206
2219
|
- bearerAuth: []
|
|
2207
2220
|
parameters:
|
|
@@ -2227,12 +2240,12 @@ paths:
|
|
|
2227
2240
|
description: Unauthorized
|
|
2228
2241
|
404:
|
|
2229
2242
|
description: Not found
|
|
2230
|
-
/admin/collection/{collectionId}/
|
|
2231
|
-
|
|
2243
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}/createTag:
|
|
2244
|
+
post:
|
|
2232
2245
|
tags:
|
|
2233
2246
|
- claimSet
|
|
2234
|
-
summary: Get
|
|
2235
|
-
operationId:
|
|
2247
|
+
summary: Get assigned tags for a claim set — tags soft-assigned to a collection or product.
|
|
2248
|
+
operationId: claimSet_createTag
|
|
2236
2249
|
security:
|
|
2237
2250
|
- bearerAuth: []
|
|
2238
2251
|
parameters:
|
|
@@ -2251,19 +2264,26 @@ paths:
|
|
|
2251
2264
|
description: Success
|
|
2252
2265
|
content:
|
|
2253
2266
|
application/json:
|
|
2254
|
-
schema:
|
|
2267
|
+
schema:
|
|
2268
|
+
$ref: "#/components/schemas/CreateClaimSetTagResponse"
|
|
2255
2269
|
400:
|
|
2256
2270
|
description: Bad request
|
|
2257
2271
|
401:
|
|
2258
2272
|
description: Unauthorized
|
|
2259
2273
|
404:
|
|
2260
2274
|
description: Not found
|
|
2261
|
-
|
|
2275
|
+
requestBody:
|
|
2276
|
+
required: true
|
|
2277
|
+
content:
|
|
2278
|
+
application/json:
|
|
2279
|
+
schema:
|
|
2280
|
+
$ref: "#/components/schemas/CreateClaimSetTagRequest"
|
|
2281
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}/importTags:
|
|
2262
2282
|
post:
|
|
2263
2283
|
tags:
|
|
2264
2284
|
- claimSet
|
|
2265
|
-
summary:
|
|
2266
|
-
operationId:
|
|
2285
|
+
summary: Create a single tag inside a claim set.
|
|
2286
|
+
operationId: claimSet_importTags
|
|
2267
2287
|
security:
|
|
2268
2288
|
- bearerAuth: []
|
|
2269
2289
|
parameters:
|
|
@@ -2283,7 +2303,7 @@ paths:
|
|
|
2283
2303
|
content:
|
|
2284
2304
|
application/json:
|
|
2285
2305
|
schema:
|
|
2286
|
-
$ref: "#/components/schemas/
|
|
2306
|
+
$ref: "#/components/schemas/ImportClaimSetTagsResponse"
|
|
2287
2307
|
400:
|
|
2288
2308
|
description: Bad request
|
|
2289
2309
|
401:
|
|
@@ -2295,12 +2315,12 @@ paths:
|
|
|
2295
2315
|
content:
|
|
2296
2316
|
application/json:
|
|
2297
2317
|
schema:
|
|
2298
|
-
$ref: "#/components/schemas/
|
|
2299
|
-
/admin/collection/{collectionId}/
|
|
2318
|
+
$ref: "#/components/schemas/ImportClaimSetTagsRequest"
|
|
2319
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}/report:
|
|
2300
2320
|
get:
|
|
2301
2321
|
tags:
|
|
2302
2322
|
- claimSet
|
|
2303
|
-
summary:
|
|
2323
|
+
summary: Bulk import tags into a claim set.
|
|
2304
2324
|
operationId: claimSet_getReport
|
|
2305
2325
|
security:
|
|
2306
2326
|
- bearerAuth: []
|
|
@@ -2327,11 +2347,11 @@ paths:
|
|
|
2327
2347
|
description: Unauthorized
|
|
2328
2348
|
404:
|
|
2329
2349
|
description: Not found
|
|
2330
|
-
/admin/collection/{collectionId}/
|
|
2350
|
+
/admin/collection/{collectionId}/claimSetd)}/{claimSetId}/tags:
|
|
2331
2351
|
get:
|
|
2332
2352
|
tags:
|
|
2333
2353
|
- claimSet
|
|
2334
|
-
summary:
|
|
2354
|
+
summary: Update a claim set.
|
|
2335
2355
|
operationId: claimSet_getAllTags
|
|
2336
2356
|
security:
|
|
2337
2357
|
- bearerAuth: []
|
|
@@ -2351,9 +2371,7 @@ paths:
|
|
|
2351
2371
|
description: Success
|
|
2352
2372
|
content:
|
|
2353
2373
|
application/json:
|
|
2354
|
-
schema:
|
|
2355
|
-
type: array
|
|
2356
|
-
items: {}
|
|
2374
|
+
schema: {}
|
|
2357
2375
|
400:
|
|
2358
2376
|
description: Bad request
|
|
2359
2377
|
401:
|
|
@@ -8656,38 +8674,6 @@ paths:
|
|
|
8656
8674
|
description: Unauthorized
|
|
8657
8675
|
404:
|
|
8658
8676
|
description: Not found
|
|
8659
|
-
/platform/claimSet/{claimSetId}/createTag:
|
|
8660
|
-
post:
|
|
8661
|
-
tags:
|
|
8662
|
-
- claimSet
|
|
8663
|
-
summary: Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets).
|
|
8664
|
-
operationId: claimSet_createTagPlatform
|
|
8665
|
-
security: []
|
|
8666
|
-
parameters:
|
|
8667
|
-
- name: claimSetId
|
|
8668
|
-
in: path
|
|
8669
|
-
required: true
|
|
8670
|
-
schema:
|
|
8671
|
-
type: string
|
|
8672
|
-
responses:
|
|
8673
|
-
200:
|
|
8674
|
-
description: Success
|
|
8675
|
-
content:
|
|
8676
|
-
application/json:
|
|
8677
|
-
schema:
|
|
8678
|
-
$ref: "#/components/schemas/CreateClaimSetTagResponse"
|
|
8679
|
-
400:
|
|
8680
|
-
description: Bad request
|
|
8681
|
-
401:
|
|
8682
|
-
description: Unauthorized
|
|
8683
|
-
404:
|
|
8684
|
-
description: Not found
|
|
8685
|
-
requestBody:
|
|
8686
|
-
required: true
|
|
8687
|
-
content:
|
|
8688
|
-
application/json:
|
|
8689
|
-
schema:
|
|
8690
|
-
$ref: "#/components/schemas/CreateClaimSetTagRequest"
|
|
8691
8677
|
/platform/location:
|
|
8692
8678
|
post:
|
|
8693
8679
|
tags:
|
|
@@ -16896,6 +16882,51 @@ components:
|
|
|
16896
16882
|
data:
|
|
16897
16883
|
type: object
|
|
16898
16884
|
additionalProperties: true
|
|
16885
|
+
CreateClaimSetRequest:
|
|
16886
|
+
type: object
|
|
16887
|
+
properties:
|
|
16888
|
+
name:
|
|
16889
|
+
type: string
|
|
16890
|
+
claimMode:
|
|
16891
|
+
type: string
|
|
16892
|
+
allocationMode:
|
|
16893
|
+
type: string
|
|
16894
|
+
required:
|
|
16895
|
+
- name
|
|
16896
|
+
- claimMode
|
|
16897
|
+
- allocationMode
|
|
16898
|
+
ImportClaimSetTagItem:
|
|
16899
|
+
type: object
|
|
16900
|
+
properties:
|
|
16901
|
+
id:
|
|
16902
|
+
type: string
|
|
16903
|
+
tagId:
|
|
16904
|
+
type: string
|
|
16905
|
+
index:
|
|
16906
|
+
type: number
|
|
16907
|
+
required:
|
|
16908
|
+
- id
|
|
16909
|
+
ImportClaimSetTagsRequest:
|
|
16910
|
+
type: object
|
|
16911
|
+
properties:
|
|
16912
|
+
tags:
|
|
16913
|
+
type: array
|
|
16914
|
+
items:
|
|
16915
|
+
$ref: "#/components/schemas/ImportClaimSetTagItem"
|
|
16916
|
+
mode:
|
|
16917
|
+
type: string
|
|
16918
|
+
enum:
|
|
16919
|
+
- upsert
|
|
16920
|
+
- replace
|
|
16921
|
+
required:
|
|
16922
|
+
- tags
|
|
16923
|
+
ImportClaimSetTagsResponse:
|
|
16924
|
+
type: object
|
|
16925
|
+
properties:
|
|
16926
|
+
written:
|
|
16927
|
+
type: number
|
|
16928
|
+
required:
|
|
16929
|
+
- written
|
|
16899
16930
|
CreateClaimSetTagResponse:
|
|
16900
16931
|
type: object
|
|
16901
16932
|
properties:
|