@proveanything/smartlinks 1.9.13 → 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/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}/claimSet:
1980
- get:
1979
+ /admin/collection/{collectionId}/claimSetd)}/assignClaims:
1980
+ post:
1981
1981
  tags:
1982
1982
  - claimSet
1983
- summary: Get all claim sets for a collection.
1984
- operationId: claimSet_getAllForCollection
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: Perform a tag query for a collection.
2011
- operationId: claimSet_createForCollection
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
- put:
2037
+ /admin/collection/{collectionId}/claimSetd)}/tagQuery:
2038
+ post:
2033
2039
  tags:
2034
2040
  - claimSet
2035
- summary: Create a new claim set for a collection.
2036
- operationId: claimSet_updateForCollection
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}/claimSet/assignClaims:
2058
- post:
2063
+ /admin/collection/{collectionId}/claimSetd)}/tagSummary:
2064
+ get:
2059
2065
  tags:
2060
2066
  - claimSet
2061
- summary: Assign claims to a claim set.
2062
- operationId: claimSet_assignClaims
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
- requestBody:
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: Update a claim set for a collection.
2094
- operationId: claimSet_makeClaim
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
- /admin/collection/{collectionId}/claimSet/tagQuery:
2116
- post:
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: Get tag summary for a collection.
2120
- operationId: claimSet_tagQuery
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
- /admin/collection/{collectionId}/claimSet/tagSummary:
2142
- get:
2152
+ put:
2143
2153
  tags:
2144
2154
  - claimSet
2145
- summary: Get assigned tags for a claim set.
2146
- operationId: claimSet_getTagSummary
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
- /admin/collection/{collectionId}/claimSet/updateClaimData:
2168
- post:
2182
+ delete:
2169
2183
  tags:
2170
2184
  - claimSet
2171
- summary: Update claim data for a collection.
2172
- operationId: claimSet_updateClaimData
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
- requestBody:
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 claim sets for a collection.
2204
- operationId: claimSet_getForCollection
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}/claimSet/{claimSetId}/assignedTags:
2231
- get:
2243
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/createTag:
2244
+ post:
2232
2245
  tags:
2233
2246
  - claimSet
2234
- summary: Get a report for a claim set.
2235
- operationId: claimSet_getAssignedTags
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
- /admin/collection/{collectionId}/claimSet/{claimSetId}/createTag:
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: Update claim data for a collection.
2266
- operationId: claimSet_createTag
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/CreateClaimSetTagResponse"
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/CreateClaimSetTagRequest"
2299
- /admin/collection/{collectionId}/claimSet/{claimSetId}/report:
2318
+ $ref: "#/components/schemas/ImportClaimSetTagsRequest"
2319
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/report:
2300
2320
  get:
2301
2321
  tags:
2302
2322
  - claimSet
2303
- summary: Get all tags for a claim set.
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}/claimSet/{claimSetId}/tags:
2350
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/tags:
2331
2351
  get:
2332
2352
  tags:
2333
2353
  - claimSet
2334
- summary: Get a specific claim set for a collection.
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:
@@ -57,6 +57,48 @@ export interface CreateClaimSetTagRequest {
57
57
  /** Arbitrary extra fields */
58
58
  data?: Record<string, unknown>;
59
59
  }
60
+ /**
61
+ * Request body for creating a new claim set.
62
+ */
63
+ export interface CreateClaimSetRequest {
64
+ /** Display name for the claim set */
65
+ name: string;
66
+ /** How tags are claimed (e.g. "nfc", "qr") */
67
+ claimMode: string;
68
+ /** How tags are allocated (e.g. "specific", "random") */
69
+ allocationMode: string;
70
+ }
71
+ /**
72
+ * A single tag entry within an importTags request.
73
+ */
74
+ export interface ImportClaimSetTagItem {
75
+ /** Tag identifier (required) */
76
+ id: string;
77
+ /** Optional matching tag/NFC identifier */
78
+ tagId?: string;
79
+ /** Optional position index */
80
+ index?: number;
81
+ }
82
+ /**
83
+ * Request body for bulk-importing tags into a claim set.
84
+ */
85
+ export interface ImportClaimSetTagsRequest {
86
+ /** Array of tag objects to import */
87
+ tags: ImportClaimSetTagItem[];
88
+ /**
89
+ * Import mode:
90
+ * - "upsert" (default) merges with existing tags
91
+ * - "replace" wipes all existing tags first then writes the new set
92
+ */
93
+ mode?: 'upsert' | 'replace';
94
+ }
95
+ /**
96
+ * Response returned by the importTags endpoint.
97
+ */
98
+ export interface ImportClaimSetTagsResponse {
99
+ /** Number of tags written */
100
+ written: number;
101
+ }
60
102
  /**
61
103
  * Response body returned after a tag/code is created inside a claim set.
62
104
  */
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.9.13 | Generated: 2026-03-31T17:02:49.636Z
3
+ Version: 1.9.14 | Generated: 2026-03-31T19:46:30.667Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -2866,6 +2866,42 @@ interface CreateClaimSetTagRequest {
2866
2866
  }
2867
2867
  ```
2868
2868
 
2869
+ **CreateClaimSetRequest** (interface)
2870
+ ```typescript
2871
+ interface CreateClaimSetRequest {
2872
+ name: string
2873
+ claimMode: string
2874
+ allocationMode: string
2875
+ }
2876
+ ```
2877
+
2878
+ **ImportClaimSetTagItem** (interface)
2879
+ ```typescript
2880
+ interface ImportClaimSetTagItem {
2881
+ id: string
2882
+ tagId?: string
2883
+ index?: number
2884
+ }
2885
+ ```
2886
+
2887
+ **ImportClaimSetTagsRequest** (interface)
2888
+ ```typescript
2889
+ interface ImportClaimSetTagsRequest {
2890
+ tags: ImportClaimSetTagItem[]
2891
+ * Import mode:
2892
+ * - "upsert" (default) merges with existing tags
2893
+ * - "replace" wipes all existing tags first then writes the new set
2894
+ mode?: 'upsert' | 'replace'
2895
+ }
2896
+ ```
2897
+
2898
+ **ImportClaimSetTagsResponse** (interface)
2899
+ ```typescript
2900
+ interface ImportClaimSetTagsResponse {
2901
+ written: number
2902
+ }
2903
+ ```
2904
+
2869
2905
  **CreateClaimSetTagResponse** (interface)
2870
2906
  ```typescript
2871
2907
  interface CreateClaimSetTagResponse {
@@ -7425,20 +7461,39 @@ Create a Responses API request (streaming or non-streaming)
7425
7461
 
7426
7462
  ### claimSet
7427
7463
 
7428
- **getAllForCollection**(collectionId: string) → `Promise<any[]>`
7429
- Get all claim sets for a collection.
7464
+ **getAll**(collectionId?: string) → `Promise<any[]>`
7465
+ Get all claim sets. When collectionId is provided, returns claim sets for that collection. When omitted, returns all claim sets owned by the authenticated user.
7430
7466
 
7431
- **getForCollection**(collectionId: string, claimSetId: string) → `Promise<any>`
7432
- Get a specific claim set for a collection.
7467
+ **get**(claimSetId: string, collectionId?: string) → `Promise<any>`
7468
+ Get a specific claim set by ID.
7433
7469
 
7434
- **getAllTags**(collectionId: string, claimSetId: string) → `Promise<any[]>`
7435
- Get all tags for a claim set.
7470
+ **create**(params: CreateClaimSetRequest, collectionId?: string) → `Promise<any>`
7471
+ Create a new claim set. When collectionId is provided, creates it scoped to that collection. When omitted, creates a global user-owned claim set.
7436
7472
 
7437
- **getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
7438
- Get a report for a claim set.
7473
+ **update**(claimSetId: string, params: any, collectionId?: string) → `Promise<any>`
7474
+ Update a claim set.
7475
+
7476
+ **remove**(claimSetId: string, collectionId?: string) → `Promise<any>`
7477
+ Delete (soft-delete) a claim set.
7478
+
7479
+ **getAllTags**(claimSetId: string, collectionId?: string) → `Promise<any>`
7480
+ Get all tags for a claim set (including data).
7481
+
7482
+ **getAssignedTags**(claimSetId: string, collectionId?: string) → `Promise<any>`
7483
+ Get assigned tags for a claim set — tags soft-assigned to a collection or product.
7439
7484
 
7440
- **getAssignedTags**(collectionId: string, claimSetId: string) → `Promise<any>`
7441
- Get assigned tags for a claim set.
7485
+ **createTag**(claimSetId: string,
7486
+ data: CreateClaimSetTagRequest,
7487
+ collectionId?: string) → `Promise<CreateClaimSetTagResponse>`
7488
+ Create a single tag inside a claim set.
7489
+
7490
+ **importTags**(claimSetId: string,
7491
+ data: ImportClaimSetTagsRequest,
7492
+ collectionId?: string) → `Promise<ImportClaimSetTagsResponse>`
7493
+ Bulk import tags into a claim set.
7494
+
7495
+ **getReport**(collectionId: string, claimSetId: string) → `Promise<any>`
7496
+ Get a report for a claim set (collection-scoped).
7442
7497
 
7443
7498
  **getTagSummary**(collectionId: string) → `Promise<any>`
7444
7499
  Get tag summary for a collection.
@@ -7446,29 +7501,14 @@ Get tag summary for a collection.
7446
7501
  **tagQuery**(collectionId: string, data: any) → `Promise<any>`
7447
7502
  Perform a tag query for a collection.
7448
7503
 
7449
- **createForCollection**(collectionId: string, params: any) → `Promise<any>`
7450
- Create a new claim set for a collection.
7451
-
7452
- **updateForCollection**(collectionId: string, params: any) → `Promise<any>`
7453
- Update a claim set for a collection.
7454
-
7455
7504
  **makeClaim**(collectionId: string, params: any) → `Promise<any>`
7456
- Make a claim for a claim set.
7505
+ Make a claim against a claim set (collection-scoped).
7457
7506
 
7458
7507
  **assignClaims**(collectionId: string, data: AssignClaimsRequest) → `Promise<any>`
7459
- Assign claims to a claim set. { id: string, // claim set id (required) collectionId: string,// required productId: string, // required batchId?: string, // optional start?: number, // optional bulk range start end?: number, // optional bulk range end codeId?: string, // optional single code data?: { [k: string]: any } // optional claim key/values }
7508
+ Assign claims to codes or ranges within a collection.
7460
7509
 
7461
7510
  **updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
7462
- Update claim data for a collection.
7463
-
7464
- **createTag**(collectionId: string,
7465
- claimSetId: string,
7466
- data: CreateClaimSetTagRequest) → `Promise<CreateClaimSetTagResponse>`
7467
- Create a single tag/code inside an existing claim set (collection admin). POST /admin/collection/:collectionId/claimSet/:claimSetId/createTag
7468
-
7469
- **createTagPlatform**(claimSetId: string,
7470
- data: CreateClaimSetTagRequest) → `Promise<CreateClaimSetTagResponse>`
7471
- Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets). POST /platform/claimSet/:claimSetId/createTag
7511
+ Update claim data for a claim set (collection-scoped).
7472
7512
 
7473
7513
  ### collection
7474
7514