@proveanything/smartlinks 1.9.13 → 1.9.15

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
@@ -32,6 +32,7 @@ tags:
32
32
  - name: claimSet
33
33
  - name: collection
34
34
  - name: comms
35
+ - name: config
35
36
  - name: contact
36
37
  - name: containers
37
38
  - name: crate
@@ -1976,12 +1977,12 @@ paths:
1976
1977
  application/json:
1977
1978
  schema:
1978
1979
  $ref: "#/components/schemas/BroadcastSendTestRequest"
1979
- /admin/collection/{collectionId}/claimSet:
1980
- get:
1980
+ /admin/collection/{collectionId}/claimSetd)}/assignClaims:
1981
+ post:
1981
1982
  tags:
1982
1983
  - claimSet
1983
- summary: Get all claim sets for a collection.
1984
- operationId: claimSet_getAllForCollection
1984
+ summary: Perform a tag query for a collection.
1985
+ operationId: claimSet_assignClaims
1985
1986
  security:
1986
1987
  - bearerAuth: []
1987
1988
  parameters:
@@ -1995,20 +1996,25 @@ paths:
1995
1996
  description: Success
1996
1997
  content:
1997
1998
  application/json:
1998
- schema:
1999
- type: array
2000
- items: {}
1999
+ schema: {}
2001
2000
  400:
2002
2001
  description: Bad request
2003
2002
  401:
2004
2003
  description: Unauthorized
2005
2004
  404:
2006
2005
  description: Not found
2006
+ requestBody:
2007
+ required: true
2008
+ content:
2009
+ application/json:
2010
+ schema:
2011
+ $ref: "#/components/schemas/AssignClaimsRequest"
2012
+ /admin/collection/{collectionId}/claimSetd)}/makeClaim:
2007
2013
  post:
2008
2014
  tags:
2009
2015
  - claimSet
2010
- summary: Perform a tag query for a collection.
2011
- operationId: claimSet_createForCollection
2016
+ summary: Get tag summary for a collection.
2017
+ operationId: claimSet_makeClaim
2012
2018
  security:
2013
2019
  - bearerAuth: []
2014
2020
  parameters:
@@ -2029,11 +2035,12 @@ paths:
2029
2035
  description: Unauthorized
2030
2036
  404:
2031
2037
  description: Not found
2032
- put:
2038
+ /admin/collection/{collectionId}/claimSetd)}/tagQuery:
2039
+ post:
2033
2040
  tags:
2034
2041
  - claimSet
2035
- summary: Create a new claim set for a collection.
2036
- operationId: claimSet_updateForCollection
2042
+ summary: Get a report for a claim set (collection-scoped).
2043
+ operationId: claimSet_tagQuery
2037
2044
  security:
2038
2045
  - bearerAuth: []
2039
2046
  parameters:
@@ -2054,12 +2061,12 @@ paths:
2054
2061
  description: Unauthorized
2055
2062
  404:
2056
2063
  description: Not found
2057
- /admin/collection/{collectionId}/claimSet/assignClaims:
2058
- post:
2064
+ /admin/collection/{collectionId}/claimSetd)}/tagSummary:
2065
+ get:
2059
2066
  tags:
2060
2067
  - claimSet
2061
- summary: Assign claims to a claim set.
2062
- operationId: claimSet_assignClaims
2068
+ summary: Get a report for a claim set (collection-scoped).
2069
+ operationId: claimSet_getTagSummary
2063
2070
  security:
2064
2071
  - bearerAuth: []
2065
2072
  parameters:
@@ -2080,18 +2087,12 @@ paths:
2080
2087
  description: Unauthorized
2081
2088
  404:
2082
2089
  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:
2090
+ /admin/collection/{collectionId}/claimSetd)}/updateClaimData:
2090
2091
  post:
2091
2092
  tags:
2092
2093
  - claimSet
2093
- summary: Update a claim set for a collection.
2094
- operationId: claimSet_makeClaim
2094
+ summary: Make a claim against a claim set (collection-scoped).
2095
+ operationId: claimSet_updateClaimData
2095
2096
  security:
2096
2097
  - bearerAuth: []
2097
2098
  parameters:
@@ -2112,12 +2113,18 @@ paths:
2112
2113
  description: Unauthorized
2113
2114
  404:
2114
2115
  description: Not found
2115
- /admin/collection/{collectionId}/claimSet/tagQuery:
2116
- post:
2116
+ requestBody:
2117
+ required: true
2118
+ content:
2119
+ application/json:
2120
+ schema:
2121
+ $ref: "#/components/schemas/UpdateClaimDataRequest"
2122
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}:
2123
+ get:
2117
2124
  tags:
2118
2125
  - claimSet
2119
- summary: Get tag summary for a collection.
2120
- operationId: claimSet_tagQuery
2126
+ summary: Returns the base path for claim set endpoints.
2127
+ operationId: claimSet_get
2121
2128
  security:
2122
2129
  - bearerAuth: []
2123
2130
  parameters:
@@ -2126,6 +2133,11 @@ paths:
2126
2133
  required: true
2127
2134
  schema:
2128
2135
  type: string
2136
+ - name: claimSetId
2137
+ in: path
2138
+ required: true
2139
+ schema:
2140
+ type: string
2129
2141
  responses:
2130
2142
  200:
2131
2143
  description: Success
@@ -2138,12 +2150,11 @@ paths:
2138
2150
  description: Unauthorized
2139
2151
  404:
2140
2152
  description: Not found
2141
- /admin/collection/{collectionId}/claimSet/tagSummary:
2142
- get:
2153
+ put:
2143
2154
  tags:
2144
2155
  - claimSet
2145
- summary: Get assigned tags for a claim set.
2146
- operationId: claimSet_getTagSummary
2156
+ summary: Create a new claim set.
2157
+ operationId: claimSet_update
2147
2158
  security:
2148
2159
  - bearerAuth: []
2149
2160
  parameters:
@@ -2152,6 +2163,11 @@ paths:
2152
2163
  required: true
2153
2164
  schema:
2154
2165
  type: string
2166
+ - name: claimSetId
2167
+ in: path
2168
+ required: true
2169
+ schema:
2170
+ type: string
2155
2171
  responses:
2156
2172
  200:
2157
2173
  description: Success
@@ -2164,12 +2180,11 @@ paths:
2164
2180
  description: Unauthorized
2165
2181
  404:
2166
2182
  description: Not found
2167
- /admin/collection/{collectionId}/claimSet/updateClaimData:
2168
- post:
2183
+ delete:
2169
2184
  tags:
2170
2185
  - claimSet
2171
- summary: Update claim data for a collection.
2172
- operationId: claimSet_updateClaimData
2186
+ summary: Update a claim set.
2187
+ operationId: claimSet_remove
2173
2188
  security:
2174
2189
  - bearerAuth: []
2175
2190
  parameters:
@@ -2178,6 +2193,11 @@ paths:
2178
2193
  required: true
2179
2194
  schema:
2180
2195
  type: string
2196
+ - name: claimSetId
2197
+ in: path
2198
+ required: true
2199
+ schema:
2200
+ type: string
2181
2201
  responses:
2182
2202
  200:
2183
2203
  description: Success
@@ -2190,18 +2210,12 @@ paths:
2190
2210
  description: Unauthorized
2191
2211
  404:
2192
2212
  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}:
2213
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/assignedTags:
2200
2214
  get:
2201
2215
  tags:
2202
2216
  - claimSet
2203
- summary: Get all claim sets for a collection.
2204
- operationId: claimSet_getForCollection
2217
+ summary: Get all tags for a claim set (including data).
2218
+ operationId: claimSet_getAssignedTags
2205
2219
  security:
2206
2220
  - bearerAuth: []
2207
2221
  parameters:
@@ -2227,12 +2241,12 @@ paths:
2227
2241
  description: Unauthorized
2228
2242
  404:
2229
2243
  description: Not found
2230
- /admin/collection/{collectionId}/claimSet/{claimSetId}/assignedTags:
2231
- get:
2244
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/createTag:
2245
+ post:
2232
2246
  tags:
2233
2247
  - claimSet
2234
- summary: Get a report for a claim set.
2235
- operationId: claimSet_getAssignedTags
2248
+ summary: Get assigned tags for a claim set — tags soft-assigned to a collection or product.
2249
+ operationId: claimSet_createTag
2236
2250
  security:
2237
2251
  - bearerAuth: []
2238
2252
  parameters:
@@ -2251,19 +2265,26 @@ paths:
2251
2265
  description: Success
2252
2266
  content:
2253
2267
  application/json:
2254
- schema: {}
2268
+ schema:
2269
+ $ref: "#/components/schemas/CreateClaimSetTagResponse"
2255
2270
  400:
2256
2271
  description: Bad request
2257
2272
  401:
2258
2273
  description: Unauthorized
2259
2274
  404:
2260
2275
  description: Not found
2261
- /admin/collection/{collectionId}/claimSet/{claimSetId}/createTag:
2276
+ requestBody:
2277
+ required: true
2278
+ content:
2279
+ application/json:
2280
+ schema:
2281
+ $ref: "#/components/schemas/CreateClaimSetTagRequest"
2282
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/importTags:
2262
2283
  post:
2263
2284
  tags:
2264
2285
  - claimSet
2265
- summary: Update claim data for a collection.
2266
- operationId: claimSet_createTag
2286
+ summary: Create a single tag inside a claim set.
2287
+ operationId: claimSet_importTags
2267
2288
  security:
2268
2289
  - bearerAuth: []
2269
2290
  parameters:
@@ -2283,7 +2304,7 @@ paths:
2283
2304
  content:
2284
2305
  application/json:
2285
2306
  schema:
2286
- $ref: "#/components/schemas/CreateClaimSetTagResponse"
2307
+ $ref: "#/components/schemas/ImportClaimSetTagsResponse"
2287
2308
  400:
2288
2309
  description: Bad request
2289
2310
  401:
@@ -2295,12 +2316,12 @@ paths:
2295
2316
  content:
2296
2317
  application/json:
2297
2318
  schema:
2298
- $ref: "#/components/schemas/CreateClaimSetTagRequest"
2299
- /admin/collection/{collectionId}/claimSet/{claimSetId}/report:
2319
+ $ref: "#/components/schemas/ImportClaimSetTagsRequest"
2320
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/report:
2300
2321
  get:
2301
2322
  tags:
2302
2323
  - claimSet
2303
- summary: Get all tags for a claim set.
2324
+ summary: Bulk import tags into a claim set.
2304
2325
  operationId: claimSet_getReport
2305
2326
  security:
2306
2327
  - bearerAuth: []
@@ -2327,11 +2348,11 @@ paths:
2327
2348
  description: Unauthorized
2328
2349
  404:
2329
2350
  description: Not found
2330
- /admin/collection/{collectionId}/claimSet/{claimSetId}/tags:
2351
+ /admin/collection/{collectionId}/claimSetd)}/{claimSetId}/tags:
2331
2352
  get:
2332
2353
  tags:
2333
2354
  - claimSet
2334
- summary: Get a specific claim set for a collection.
2355
+ summary: Update a claim set.
2335
2356
  operationId: claimSet_getAllTags
2336
2357
  security:
2337
2358
  - bearerAuth: []
@@ -2351,9 +2372,7 @@ paths:
2351
2372
  description: Success
2352
2373
  content:
2353
2374
  application/json:
2354
- schema:
2355
- type: array
2356
- items: {}
2375
+ schema: {}
2357
2376
  400:
2358
2377
  description: Bad request
2359
2378
  401:
@@ -8656,38 +8675,6 @@ paths:
8656
8675
  description: Unauthorized
8657
8676
  404:
8658
8677
  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
8678
  /platform/location:
8692
8679
  post:
8693
8680
  tags:
@@ -11845,6 +11832,50 @@ paths:
11845
11832
  application/json:
11846
11833
  schema:
11847
11834
  $ref: "#/components/schemas/TranslationLookupRequest"
11835
+ /public/config/fields:
11836
+ get:
11837
+ tags:
11838
+ - config
11839
+ summary: Returns the full platform field catalog.
11840
+ operationId: config_getFields
11841
+ security: []
11842
+ responses:
11843
+ 200:
11844
+ description: Success
11845
+ content:
11846
+ application/json:
11847
+ schema:
11848
+ type: array
11849
+ items:
11850
+ $ref: "#/components/schemas/FieldDefinition"
11851
+ 400:
11852
+ description: Bad request
11853
+ 401:
11854
+ description: Unauthorized
11855
+ 404:
11856
+ description: Not found
11857
+ /public/config/proofTypes:
11858
+ get:
11859
+ tags:
11860
+ - config
11861
+ summary: Returns the full platform field catalog.
11862
+ operationId: config_getProofTypes
11863
+ security: []
11864
+ responses:
11865
+ 200:
11866
+ description: Success
11867
+ content:
11868
+ application/json:
11869
+ schema:
11870
+ type: array
11871
+ items:
11872
+ $ref: "#/components/schemas/ProofTypeDefinition"
11873
+ 400:
11874
+ description: Bad request
11875
+ 401:
11876
+ description: Unauthorized
11877
+ 404:
11878
+ description: Not found
11848
11879
  /public/location/{locationId}:
11849
11880
  get:
11850
11881
  tags:
@@ -16896,6 +16927,51 @@ components:
16896
16927
  data:
16897
16928
  type: object
16898
16929
  additionalProperties: true
16930
+ CreateClaimSetRequest:
16931
+ type: object
16932
+ properties:
16933
+ name:
16934
+ type: string
16935
+ claimMode:
16936
+ type: string
16937
+ allocationMode:
16938
+ type: string
16939
+ required:
16940
+ - name
16941
+ - claimMode
16942
+ - allocationMode
16943
+ ImportClaimSetTagItem:
16944
+ type: object
16945
+ properties:
16946
+ id:
16947
+ type: string
16948
+ tagId:
16949
+ type: string
16950
+ index:
16951
+ type: number
16952
+ required:
16953
+ - id
16954
+ ImportClaimSetTagsRequest:
16955
+ type: object
16956
+ properties:
16957
+ tags:
16958
+ type: array
16959
+ items:
16960
+ $ref: "#/components/schemas/ImportClaimSetTagItem"
16961
+ mode:
16962
+ type: string
16963
+ enum:
16964
+ - upsert
16965
+ - replace
16966
+ required:
16967
+ - tags
16968
+ ImportClaimSetTagsResponse:
16969
+ type: object
16970
+ properties:
16971
+ written:
16972
+ type: number
16973
+ required:
16974
+ - written
16899
16975
  CreateClaimSetTagResponse:
16900
16976
  type: object
16901
16977
  properties:
@@ -17660,6 +17736,132 @@ components:
17660
17736
  required:
17661
17737
  - ok
17662
17738
  - error
17739
+ FieldOption:
17740
+ type: object
17741
+ properties:
17742
+ label:
17743
+ type: string
17744
+ value:
17745
+ type: string
17746
+ required:
17747
+ - label
17748
+ - value
17749
+ FieldDefinition:
17750
+ type: object
17751
+ properties:
17752
+ id:
17753
+ type: string
17754
+ label:
17755
+ type: string
17756
+ storageKey:
17757
+ type: string
17758
+ type:
17759
+ $ref: "#/components/schemas/FieldType"
17760
+ options:
17761
+ type: array
17762
+ items:
17763
+ $ref: "#/components/schemas/FieldOption"
17764
+ required:
17765
+ type: boolean
17766
+ col:
17767
+ type: number
17768
+ placeholder:
17769
+ type: string
17770
+ help:
17771
+ type: string
17772
+ min:
17773
+ type: number
17774
+ max:
17775
+ type: number
17776
+ step:
17777
+ type: number
17778
+ rows:
17779
+ type: number
17780
+ autoGrow:
17781
+ type: boolean
17782
+ accept:
17783
+ type: string
17784
+ clearable:
17785
+ type: boolean
17786
+ disabled:
17787
+ type: boolean
17788
+ showIf:
17789
+ type: object
17790
+ additionalProperties: true
17791
+ required:
17792
+ - id
17793
+ - label
17794
+ - type
17795
+ ProofTypeDefinition:
17796
+ type: object
17797
+ properties:
17798
+ id:
17799
+ type: string
17800
+ name:
17801
+ type: string
17802
+ description:
17803
+ type: string
17804
+ category:
17805
+ type: string
17806
+ active:
17807
+ type: boolean
17808
+ group:
17809
+ type: boolean
17810
+ proofTypes:
17811
+ type: array
17812
+ items:
17813
+ $ref: "#/components/schemas/ProofMechanism"
17814
+ proofType:
17815
+ $ref: "#/components/schemas/ProofMechanism"
17816
+ groupFields:
17817
+ type: array
17818
+ items:
17819
+ type: string
17820
+ proofFields:
17821
+ type: array
17822
+ items:
17823
+ type: string
17824
+ listFields:
17825
+ type: object
17826
+ additionalProperties:
17827
+ type: boolean
17828
+ freeApps:
17829
+ type: array
17830
+ items:
17831
+ type: string
17832
+ apps:
17833
+ type: array
17834
+ items:
17835
+ type: string
17836
+ collection:
17837
+ type: string
17838
+ action:
17839
+ type: string
17840
+ bound:
17841
+ type: string
17842
+ enum:
17843
+ - soul
17844
+ translations:
17845
+ type: object
17846
+ additionalProperties:
17847
+ type: string
17848
+ hideProductTools:
17849
+ type: boolean
17850
+ required:
17851
+ - id
17852
+ - name
17853
+ - group
17854
+ FieldType:
17855
+ type: array
17856
+ items:
17857
+ type: string
17858
+ enum:
17859
+ - text
17860
+ - email
17861
+ - url
17862
+ - textarea
17863
+ - number
17864
+ - select
17663
17865
  Contact:
17664
17866
  type: object
17665
17867
  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
  */