@proveanything/smartlinks 1.9.9 → 1.9.10

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.
@@ -1,4 +1,4 @@
1
- import { UpdateClaimDataRequest, AssignClaimsRequest } from "../types";
1
+ import { UpdateClaimDataRequest, AssignClaimsRequest, CreateClaimSetTagRequest, CreateClaimSetTagResponse } from "../types";
2
2
  export declare namespace claimSet {
3
3
  /**
4
4
  * Get all claim sets for a collection.
@@ -90,4 +90,21 @@ export declare namespace claimSet {
90
90
  * @param data – The claim data to update
91
91
  */
92
92
  function updateClaimData(collectionId: string, data: UpdateClaimDataRequest): Promise<any>;
93
+ /**
94
+ * Create a single tag/code inside an existing claim set (collection admin).
95
+ * POST /admin/collections/:collectionId/claimSets/:claimSetId/createTag
96
+ * @param collectionId – The collection identifier
97
+ * @param claimSetId – The claim set identifier
98
+ * @param data – Tag creation parameters
99
+ * @returns Promise resolving to the created tag
100
+ */
101
+ function createTag(collectionId: string, claimSetId: string, data: CreateClaimSetTagRequest): Promise<CreateClaimSetTagResponse>;
102
+ /**
103
+ * Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets).
104
+ * POST /platform/claimSets/:claimSetId/createTag
105
+ * @param claimSetId – The claim set identifier
106
+ * @param data – Tag creation parameters
107
+ * @returns Promise resolving to the created tag
108
+ */
109
+ function createTagPlatform(claimSetId: string, data: CreateClaimSetTagRequest): Promise<CreateClaimSetTagResponse>;
93
110
  }
@@ -139,4 +139,29 @@ export var claimSet;
139
139
  return post(path, data);
140
140
  }
141
141
  claimSet.updateClaimData = updateClaimData;
142
+ /**
143
+ * Create a single tag/code inside an existing claim set (collection admin).
144
+ * POST /admin/collections/:collectionId/claimSets/:claimSetId/createTag
145
+ * @param collectionId – The collection identifier
146
+ * @param claimSetId – The claim set identifier
147
+ * @param data – Tag creation parameters
148
+ * @returns Promise resolving to the created tag
149
+ */
150
+ async function createTag(collectionId, claimSetId, data) {
151
+ const path = `/admin/collections/${encodeURIComponent(collectionId)}/claimSets/${encodeURIComponent(claimSetId)}/createTag`;
152
+ return post(path, data);
153
+ }
154
+ claimSet.createTag = createTag;
155
+ /**
156
+ * Create a single tag/code inside an existing claim set (platform; requires account.features.adminClaimSets).
157
+ * POST /platform/claimSets/:claimSetId/createTag
158
+ * @param claimSetId – The claim set identifier
159
+ * @param data – Tag creation parameters
160
+ * @returns Promise resolving to the created tag
161
+ */
162
+ async function createTagPlatform(claimSetId, data) {
163
+ const path = `/platform/claimSets/${encodeURIComponent(claimSetId)}/createTag`;
164
+ return post(path, data);
165
+ }
166
+ claimSet.createTagPlatform = createTagPlatform;
142
167
  })(claimSet || (claimSet = {}));
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.9.9 | Generated: 2026-03-29T11:21:20.234Z
3
+ Version: 1.9.10 | Generated: 2026-03-31T14:43:32.638Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -2853,6 +2853,34 @@ interface AssignClaimsRequest {
2853
2853
  }
2854
2854
  ```
2855
2855
 
2856
+ **CreateClaimSetTagRequest** (interface)
2857
+ ```typescript
2858
+ interface CreateClaimSetTagRequest {
2859
+ id?: string
2860
+ tagId?: string
2861
+ productId?: string
2862
+ collectionId?: string
2863
+ batchId?: string
2864
+ password?: string
2865
+ data?: Record<string, unknown>
2866
+ }
2867
+ ```
2868
+
2869
+ **CreateClaimSetTagResponse** (interface)
2870
+ ```typescript
2871
+ interface CreateClaimSetTagResponse {
2872
+ id: string
2873
+ claimSetId: string
2874
+ createdAt: string
2875
+ tagId?: string
2876
+ productId?: string
2877
+ collectionId?: string
2878
+ batchId?: string
2879
+ password?: string
2880
+ data?: Record<string, unknown>
2881
+ }
2882
+ ```
2883
+
2856
2884
  ### collection
2857
2885
 
2858
2886
  **Collection** (interface)
@@ -7433,6 +7461,15 @@ Assign claims to a claim set. { id: string, // claim set id (required)
7433
7461
  **updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
7434
7462
  Update claim data for a collection.
7435
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/collections/:collectionId/claimSets/: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/claimSets/:claimSetId/createTag
7472
+
7436
7473
  ### collection
7437
7474
 
7438
7475
  **get**(collectionId: string, admin?: boolean) → `Promise<CollectionResponse>`
package/dist/openapi.yaml CHANGED
@@ -7980,6 +7980,44 @@ paths:
7980
7980
  application/json:
7981
7981
  schema:
7982
7982
  $ref: "#/components/schemas/TranslationUpdateRequest"
7983
+ /admin/collections/{collectionId}/claimSets/{claimSetId}/createTag:
7984
+ post:
7985
+ tags:
7986
+ - claimSet
7987
+ summary: Update claim data for a collection.
7988
+ operationId: claimSet_createTag
7989
+ security:
7990
+ - bearerAuth: []
7991
+ parameters:
7992
+ - name: collectionId
7993
+ in: path
7994
+ required: true
7995
+ schema:
7996
+ type: string
7997
+ - name: claimSetId
7998
+ in: path
7999
+ required: true
8000
+ schema:
8001
+ type: string
8002
+ responses:
8003
+ 200:
8004
+ description: Success
8005
+ content:
8006
+ application/json:
8007
+ schema:
8008
+ $ref: "#/components/schemas/CreateClaimSetTagResponse"
8009
+ 400:
8010
+ description: Bad request
8011
+ 401:
8012
+ description: Unauthorized
8013
+ 404:
8014
+ description: Not found
8015
+ requestBody:
8016
+ required: true
8017
+ content:
8018
+ application/json:
8019
+ schema:
8020
+ $ref: "#/components/schemas/CreateClaimSetTagRequest"
7983
8021
  /api/admin/auth/push:
7984
8022
  get:
7985
8023
  tags:
@@ -8618,6 +8656,38 @@ paths:
8618
8656
  description: Unauthorized
8619
8657
  404:
8620
8658
  description: Not found
8659
+ /platform/claimSets/{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"
8621
8691
  /platform/location:
8622
8692
  post:
8623
8693
  tags:
@@ -16808,6 +16878,50 @@ components:
16808
16878
  - id
16809
16879
  - collectionId
16810
16880
  - productId
16881
+ CreateClaimSetTagRequest:
16882
+ type: object
16883
+ properties:
16884
+ id:
16885
+ type: string
16886
+ tagId:
16887
+ type: string
16888
+ productId:
16889
+ type: string
16890
+ collectionId:
16891
+ type: string
16892
+ batchId:
16893
+ type: string
16894
+ password:
16895
+ type: string
16896
+ data:
16897
+ type: object
16898
+ additionalProperties: true
16899
+ CreateClaimSetTagResponse:
16900
+ type: object
16901
+ properties:
16902
+ id:
16903
+ type: string
16904
+ claimSetId:
16905
+ type: string
16906
+ createdAt:
16907
+ type: string
16908
+ tagId:
16909
+ type: string
16910
+ productId:
16911
+ type: string
16912
+ collectionId:
16913
+ type: string
16914
+ batchId:
16915
+ type: string
16916
+ password:
16917
+ type: string
16918
+ data:
16919
+ type: object
16920
+ additionalProperties: true
16921
+ required:
16922
+ - id
16923
+ - claimSetId
16924
+ - createdAt
16811
16925
  Collection:
16812
16926
  type: object
16813
16927
  properties:
@@ -38,3 +38,45 @@ export interface AssignClaimsRequest {
38
38
  /** Optional key/value pairs to set on the claim */
39
39
  data?: Record<string, any>;
40
40
  }
41
+ /**
42
+ * Request body for creating a single tag/code inside an existing claim set.
43
+ */
44
+ export interface CreateClaimSetTagRequest {
45
+ /** Optional explicit ID; a random 12-char hex ID is generated server-side if omitted */
46
+ id?: string;
47
+ /** Matching tag/NFC identifier */
48
+ tagId?: string;
49
+ /** Product to associate with this code */
50
+ productId?: string;
51
+ /** Collection scope */
52
+ collectionId?: string;
53
+ /** Batch identifier */
54
+ batchId?: string;
55
+ /** Optional password/secret for secure claim */
56
+ password?: string;
57
+ /** Arbitrary extra fields */
58
+ data?: Record<string, unknown>;
59
+ }
60
+ /**
61
+ * Response body returned after a tag/code is created inside a claim set.
62
+ */
63
+ export interface CreateClaimSetTagResponse {
64
+ /** ID of the newly created tag */
65
+ id: string;
66
+ /** The claim set this tag belongs to */
67
+ claimSetId: string;
68
+ /** ISO 8601 creation timestamp */
69
+ createdAt: string;
70
+ /** Matching tag/NFC identifier */
71
+ tagId?: string;
72
+ /** Associated product ID */
73
+ productId?: string;
74
+ /** Collection scope */
75
+ collectionId?: string;
76
+ /** Batch identifier */
77
+ batchId?: string;
78
+ /** Password/secret for secure claim */
79
+ password?: string;
80
+ /** Arbitrary extra fields */
81
+ data?: Record<string, unknown>;
82
+ }
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.9.9 | Generated: 2026-03-29T11:21:20.234Z
3
+ Version: 1.9.10 | Generated: 2026-03-31T14:43:32.638Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -2853,6 +2853,34 @@ interface AssignClaimsRequest {
2853
2853
  }
2854
2854
  ```
2855
2855
 
2856
+ **CreateClaimSetTagRequest** (interface)
2857
+ ```typescript
2858
+ interface CreateClaimSetTagRequest {
2859
+ id?: string
2860
+ tagId?: string
2861
+ productId?: string
2862
+ collectionId?: string
2863
+ batchId?: string
2864
+ password?: string
2865
+ data?: Record<string, unknown>
2866
+ }
2867
+ ```
2868
+
2869
+ **CreateClaimSetTagResponse** (interface)
2870
+ ```typescript
2871
+ interface CreateClaimSetTagResponse {
2872
+ id: string
2873
+ claimSetId: string
2874
+ createdAt: string
2875
+ tagId?: string
2876
+ productId?: string
2877
+ collectionId?: string
2878
+ batchId?: string
2879
+ password?: string
2880
+ data?: Record<string, unknown>
2881
+ }
2882
+ ```
2883
+
2856
2884
  ### collection
2857
2885
 
2858
2886
  **Collection** (interface)
@@ -7433,6 +7461,15 @@ Assign claims to a claim set. { id: string, // claim set id (required)
7433
7461
  **updateClaimData**(collectionId: string, data: UpdateClaimDataRequest) → `Promise<any>`
7434
7462
  Update claim data for a collection.
7435
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/collections/:collectionId/claimSets/: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/claimSets/:claimSetId/createTag
7472
+
7436
7473
  ### collection
7437
7474
 
7438
7475
  **get**(collectionId: string, admin?: boolean) → `Promise<CollectionResponse>`
package/openapi.yaml CHANGED
@@ -7980,6 +7980,44 @@ paths:
7980
7980
  application/json:
7981
7981
  schema:
7982
7982
  $ref: "#/components/schemas/TranslationUpdateRequest"
7983
+ /admin/collections/{collectionId}/claimSets/{claimSetId}/createTag:
7984
+ post:
7985
+ tags:
7986
+ - claimSet
7987
+ summary: Update claim data for a collection.
7988
+ operationId: claimSet_createTag
7989
+ security:
7990
+ - bearerAuth: []
7991
+ parameters:
7992
+ - name: collectionId
7993
+ in: path
7994
+ required: true
7995
+ schema:
7996
+ type: string
7997
+ - name: claimSetId
7998
+ in: path
7999
+ required: true
8000
+ schema:
8001
+ type: string
8002
+ responses:
8003
+ 200:
8004
+ description: Success
8005
+ content:
8006
+ application/json:
8007
+ schema:
8008
+ $ref: "#/components/schemas/CreateClaimSetTagResponse"
8009
+ 400:
8010
+ description: Bad request
8011
+ 401:
8012
+ description: Unauthorized
8013
+ 404:
8014
+ description: Not found
8015
+ requestBody:
8016
+ required: true
8017
+ content:
8018
+ application/json:
8019
+ schema:
8020
+ $ref: "#/components/schemas/CreateClaimSetTagRequest"
7983
8021
  /api/admin/auth/push:
7984
8022
  get:
7985
8023
  tags:
@@ -8618,6 +8656,38 @@ paths:
8618
8656
  description: Unauthorized
8619
8657
  404:
8620
8658
  description: Not found
8659
+ /platform/claimSets/{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"
8621
8691
  /platform/location:
8622
8692
  post:
8623
8693
  tags:
@@ -16808,6 +16878,50 @@ components:
16808
16878
  - id
16809
16879
  - collectionId
16810
16880
  - productId
16881
+ CreateClaimSetTagRequest:
16882
+ type: object
16883
+ properties:
16884
+ id:
16885
+ type: string
16886
+ tagId:
16887
+ type: string
16888
+ productId:
16889
+ type: string
16890
+ collectionId:
16891
+ type: string
16892
+ batchId:
16893
+ type: string
16894
+ password:
16895
+ type: string
16896
+ data:
16897
+ type: object
16898
+ additionalProperties: true
16899
+ CreateClaimSetTagResponse:
16900
+ type: object
16901
+ properties:
16902
+ id:
16903
+ type: string
16904
+ claimSetId:
16905
+ type: string
16906
+ createdAt:
16907
+ type: string
16908
+ tagId:
16909
+ type: string
16910
+ productId:
16911
+ type: string
16912
+ collectionId:
16913
+ type: string
16914
+ batchId:
16915
+ type: string
16916
+ password:
16917
+ type: string
16918
+ data:
16919
+ type: object
16920
+ additionalProperties: true
16921
+ required:
16922
+ - id
16923
+ - claimSetId
16924
+ - createdAt
16811
16925
  Collection:
16812
16926
  type: object
16813
16927
  properties:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "1.9.9",
3
+ "version": "1.9.10",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",