@proveanything/smartlinks 2.1.10 → 2.1.12

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
@@ -64,6 +64,8 @@ tags:
64
64
  description: blocks API
65
65
  - name: broadcasts
66
66
  description: Broadcast messaging campaigns.
67
+ - name: ranges
68
+ description: ranges API
67
69
  - name: collection
68
70
  description: Collection (tenant) configuration and resources.
69
71
  - name: comms
@@ -100,6 +102,8 @@ tags:
100
102
  description: NFC tag encoding and lookup.
101
103
  - name: order
102
104
  description: Order records and line items.
105
+ - name: partner
106
+ description: partner API
103
107
  - name: product
104
108
  description: Single product operations.
105
109
  - name: products
@@ -8994,6 +8998,188 @@ paths:
8994
8998
  application/json:
8995
8999
  schema:
8996
9000
  $ref: "#/components/schemas/TransactionalSendRequest"
9001
+ /admin/partner:
9002
+ get:
9003
+ tags:
9004
+ - partner
9005
+ summary: The partners you belong to, with your role in each.
9006
+ operationId: partner_list
9007
+ security:
9008
+ - bearerAuth: []
9009
+ responses:
9010
+ 200:
9011
+ description: Success
9012
+ content:
9013
+ application/json:
9014
+ schema:
9015
+ type: array
9016
+ items:
9017
+ $ref: "#/components/schemas/Partner"
9018
+ 400:
9019
+ description: Bad request
9020
+ 401:
9021
+ description: Unauthorized
9022
+ 404:
9023
+ description: Not found
9024
+ /admin/partner/{partnerId}:
9025
+ get:
9026
+ tags:
9027
+ - partner
9028
+ summary: One partner (owners also see its members).
9029
+ operationId: partner_get
9030
+ security:
9031
+ - bearerAuth: []
9032
+ parameters:
9033
+ - name: partnerId
9034
+ in: path
9035
+ required: true
9036
+ schema:
9037
+ type: string
9038
+ responses:
9039
+ 200:
9040
+ description: Success
9041
+ content:
9042
+ application/json:
9043
+ schema:
9044
+ $ref: "#/components/schemas/Partner"
9045
+ 400:
9046
+ description: Bad request
9047
+ 401:
9048
+ description: Unauthorized
9049
+ 404:
9050
+ description: Not found
9051
+ /admin/partner/{partnerId}/claimSet:
9052
+ get:
9053
+ tags:
9054
+ - partner
9055
+ summary: "The partner's claim sets."
9056
+ operationId: partner_claimSets
9057
+ security:
9058
+ - bearerAuth: []
9059
+ parameters:
9060
+ - name: partnerId
9061
+ in: path
9062
+ required: true
9063
+ schema:
9064
+ type: string
9065
+ responses:
9066
+ 200:
9067
+ description: Success
9068
+ content:
9069
+ application/json:
9070
+ schema:
9071
+ type: array
9072
+ items:
9073
+ $ref: "#/components/schemas/PartnerClaimSet"
9074
+ 400:
9075
+ description: Bad request
9076
+ 401:
9077
+ description: Unauthorized
9078
+ 404:
9079
+ description: Not found
9080
+ post:
9081
+ tags:
9082
+ - partner
9083
+ summary: A new claim set for the partner, on one of its tap domains (owners and admins).
9084
+ operationId: partner_createClaimSet
9085
+ security:
9086
+ - bearerAuth: []
9087
+ parameters:
9088
+ - name: partnerId
9089
+ in: path
9090
+ required: true
9091
+ schema:
9092
+ type: string
9093
+ responses:
9094
+ 200:
9095
+ description: Success
9096
+ content:
9097
+ application/json:
9098
+ schema:
9099
+ $ref: "#/components/schemas/PartnerClaimSet"
9100
+ 400:
9101
+ description: Bad request
9102
+ 401:
9103
+ description: Unauthorized
9104
+ 404:
9105
+ description: Not found
9106
+ requestBody:
9107
+ required: true
9108
+ content:
9109
+ application/json:
9110
+ schema:
9111
+ $ref: "#/components/schemas/CreatePartnerClaimSetRequest"
9112
+ /admin/partner/{partnerId}/claimSet/{claimSetId}:
9113
+ get:
9114
+ tags:
9115
+ - partner
9116
+ summary: "One of the partner's claim sets."
9117
+ operationId: partner_getClaimSet
9118
+ security:
9119
+ - bearerAuth: []
9120
+ parameters:
9121
+ - name: partnerId
9122
+ in: path
9123
+ required: true
9124
+ schema:
9125
+ type: string
9126
+ - name: claimSetId
9127
+ in: path
9128
+ required: true
9129
+ schema:
9130
+ type: string
9131
+ responses:
9132
+ 200:
9133
+ description: Success
9134
+ content:
9135
+ application/json:
9136
+ schema:
9137
+ $ref: "#/components/schemas/PartnerClaimSet"
9138
+ 400:
9139
+ description: Bad request
9140
+ 401:
9141
+ description: Unauthorized
9142
+ 404:
9143
+ description: Not found
9144
+ /admin/partner/{partnerId}/tags/lookup:
9145
+ get:
9146
+ tags:
9147
+ - partner
9148
+ summary: "Find a tag across the partner's sets by its chip UID (8 or 14 hex) or its code (printed or bare)."
9149
+ operationId: partner_lookupTags
9150
+ security:
9151
+ - bearerAuth: []
9152
+ parameters:
9153
+ - name: partnerId
9154
+ in: path
9155
+ required: true
9156
+ schema:
9157
+ type: string
9158
+ - name: uid
9159
+ in: query
9160
+ required: false
9161
+ schema:
9162
+ type: string
9163
+ - name: code
9164
+ in: query
9165
+ required: false
9166
+ schema:
9167
+ type: string
9168
+ responses:
9169
+ 200:
9170
+ description: Success
9171
+ content:
9172
+ application/json:
9173
+ schema:
9174
+ type: array
9175
+ items:
9176
+ $ref: "#/components/schemas/PartnerTagHit"
9177
+ 400:
9178
+ description: Bad request
9179
+ 401:
9180
+ description: Unauthorized
9181
+ 404:
9182
+ description: Not found
8997
9183
  /authKit/{authKitId}/config:
8998
9184
  get:
8999
9185
  tags:
@@ -14734,96 +14920,40 @@ paths:
14734
14920
  description: Unauthorized
14735
14921
  404:
14736
14922
  description: Not found
14737
- /{zone}/collection/{collectionId}/app/{appId}/cases:
14923
+ /{rangeId}:
14738
14924
  get:
14739
14925
  tags:
14740
- - cases
14741
- summary: List cases with optional query parameters GET /cases
14742
- operationId: cases_list
14926
+ - ranges
14927
+ summary: One range, with its counts refreshed.
14928
+ operationId: ranges_get
14743
14929
  security: []
14744
14930
  parameters:
14745
- - name: zone
14746
- in: path
14747
- required: true
14748
- schema:
14749
- type: string
14750
- - name: collectionId
14751
- in: path
14752
- required: true
14753
- schema:
14754
- type: string
14755
- - name: appId
14931
+ - name: rangeId
14756
14932
  in: path
14757
14933
  required: true
14758
14934
  schema:
14759
14935
  type: string
14760
- - name: category
14761
- in: query
14762
- required: false
14763
- schema:
14764
- type: string
14765
- - name: priority
14766
- in: query
14767
- required: false
14768
- schema:
14769
- type: string
14770
- - name: ref
14771
- in: query
14772
- required: false
14773
- schema:
14774
- type: string
14775
- - name: proofId
14776
- in: query
14777
- required: false
14778
- schema:
14779
- type: string
14780
- - name: contactId
14781
- in: query
14782
- required: false
14783
- schema:
14784
- type: string
14785
- - name: assignedTo
14786
- in: query
14787
- required: false
14788
- schema:
14789
- type: string
14790
- - name: closedAt
14791
- in: query
14792
- required: false
14793
- schema:
14794
- type: string
14795
14936
  responses:
14796
14937
  200:
14797
14938
  description: Success
14798
14939
  content:
14799
14940
  application/json:
14800
14941
  schema:
14801
- type: object
14802
- additionalProperties: true
14942
+ $ref: "#/components/schemas/ClaimSetRange"
14803
14943
  400:
14804
14944
  description: Bad request
14805
14945
  401:
14806
14946
  description: Unauthorized
14807
14947
  404:
14808
14948
  description: Not found
14809
- post:
14949
+ patch:
14810
14950
  tags:
14811
- - cases
14812
- summary: Create a new case POST /cases
14813
- operationId: cases_create
14951
+ - ranges
14952
+ summary: Name, notes, order details, or a stage move (sent to the printer, received).
14953
+ operationId: ranges_update
14814
14954
  security: []
14815
14955
  parameters:
14816
- - name: zone
14817
- in: path
14818
- required: true
14819
- schema:
14820
- type: string
14821
- - name: collectionId
14822
- in: path
14823
- required: true
14824
- schema:
14825
- type: string
14826
- - name: appId
14956
+ - name: rangeId
14827
14957
  in: path
14828
14958
  required: true
14829
14959
  schema:
@@ -14834,7 +14964,7 @@ paths:
14834
14964
  content:
14835
14965
  application/json:
14836
14966
  schema:
14837
- $ref: "#/components/schemas/AppCase"
14967
+ $ref: "#/components/schemas/ClaimSetRange"
14838
14968
  400:
14839
14969
  description: Bad request
14840
14970
  401:
@@ -14846,26 +14976,16 @@ paths:
14846
14976
  content:
14847
14977
  application/json:
14848
14978
  schema:
14849
- $ref: "#/components/schemas/CreateCaseInput"
14850
- /{zone}/collection/{collectionId}/app/{appId}/cases/aggregate:
14979
+ $ref: "#/components/schemas/UpdateClaimSetRangeRequest"
14980
+ /{rangeId}/assign:
14851
14981
  post:
14852
14982
  tags:
14853
- - cases
14854
- summary: Get aggregate statistics for cases POST /cases/aggregate
14855
- operationId: cases_aggregate
14983
+ - ranges
14984
+ summary: Point the range (or from–to within it) at a collection / product / batch, or clear it.
14985
+ operationId: ranges_assign
14856
14986
  security: []
14857
14987
  parameters:
14858
- - name: zone
14859
- in: path
14860
- required: true
14861
- schema:
14862
- type: string
14863
- - name: collectionId
14864
- in: path
14865
- required: true
14866
- schema:
14867
- type: string
14868
- - name: appId
14988
+ - name: rangeId
14869
14989
  in: path
14870
14990
  required: true
14871
14991
  schema:
@@ -14876,7 +14996,7 @@ paths:
14876
14996
  content:
14877
14997
  application/json:
14878
14998
  schema:
14879
- $ref: "#/components/schemas/AggregateResponse"
14999
+ $ref: "#/components/schemas/AssignClaimSetRangeResponse"
14880
15000
  400:
14881
15001
  description: Bad request
14882
15002
  401:
@@ -14888,26 +15008,16 @@ paths:
14888
15008
  content:
14889
15009
  application/json:
14890
15010
  schema:
14891
- $ref: "#/components/schemas/AggregateRequest"
14892
- /{zone}/collection/{collectionId}/app/{appId}/cases/summary:
14893
- post:
15011
+ $ref: "#/components/schemas/AssignClaimSetRangeRequest"
15012
+ /{rangeId}/export:
15013
+ get:
14894
15014
  tags:
14895
- - cases
14896
- summary: Get case summary (admin only) POST /cases/summary
14897
- operationId: cases_summary
15015
+ - ranges
15016
+ summary: "The printer file (CSV text in `csv`)."
15017
+ operationId: ranges_exportFile
14898
15018
  security: []
14899
15019
  parameters:
14900
- - name: zone
14901
- in: path
14902
- required: true
14903
- schema:
14904
- type: string
14905
- - name: collectionId
14906
- in: path
14907
- required: true
14908
- schema:
14909
- type: string
14910
- - name: appId
15020
+ - name: rangeId
14911
15021
  in: path
14912
15022
  required: true
14913
15023
  schema:
@@ -14918,19 +15028,367 @@ paths:
14918
15028
  content:
14919
15029
  application/json:
14920
15030
  schema:
14921
- $ref: "#/components/schemas/CaseSummaryResponse"
15031
+ $ref: "#/components/schemas/ClaimSetRangeFile"
14922
15032
  400:
14923
15033
  description: Bad request
14924
15034
  401:
14925
15035
  description: Unauthorized
14926
15036
  404:
14927
15037
  description: Not found
14928
- requestBody:
14929
- required: true
14930
- content:
14931
- application/json:
14932
- schema:
14933
- $ref: "#/components/schemas/CaseSummaryRequest"
15038
+ /{rangeId}/import:
15039
+ post:
15040
+ tags:
15041
+ - ranges
15042
+ summary: "The manufacturer's file back: check it (commit false), then write the chip UIDs (commit true)."
15043
+ operationId: ranges_importUids
15044
+ security: []
15045
+ parameters:
15046
+ - name: rangeId
15047
+ in: path
15048
+ required: true
15049
+ schema:
15050
+ type: string
15051
+ responses:
15052
+ 200:
15053
+ description: Success
15054
+ content:
15055
+ application/json:
15056
+ schema:
15057
+ $ref: "#/components/schemas/ImportClaimSetRangeUidsResponse"
15058
+ 400:
15059
+ description: Bad request
15060
+ 401:
15061
+ description: Unauthorized
15062
+ 404:
15063
+ description: Not found
15064
+ requestBody:
15065
+ required: true
15066
+ content:
15067
+ application/json:
15068
+ schema:
15069
+ $ref: "#/components/schemas/ImportClaimSetRangeUidsRequest"
15070
+ /{rangeId}/instructions:
15071
+ get:
15072
+ tags:
15073
+ - ranges
15074
+ summary: "The manufacturer's instruction sheet: PDF (base64) or Markdown."
15075
+ operationId: ranges_instructions
15076
+ security: []
15077
+ parameters:
15078
+ - name: rangeId
15079
+ in: path
15080
+ required: true
15081
+ schema:
15082
+ type: string
15083
+ responses:
15084
+ 200:
15085
+ description: Success
15086
+ content:
15087
+ application/json:
15088
+ schema:
15089
+ $ref: "#/components/schemas/ClaimSetRangeFile"
15090
+ 400:
15091
+ description: Bad request
15092
+ 401:
15093
+ description: Unauthorized
15094
+ 404:
15095
+ description: Not found
15096
+ /{rangeId}/next:
15097
+ get:
15098
+ tags:
15099
+ - ranges
15100
+ summary: The next tag to program on a phone (lowest index without a chip), with its URL and key.
15101
+ operationId: ranges_next
15102
+ security: []
15103
+ parameters:
15104
+ - name: rangeId
15105
+ in: path
15106
+ required: true
15107
+ schema:
15108
+ type: string
15109
+ responses:
15110
+ 200:
15111
+ description: Success
15112
+ content:
15113
+ application/json:
15114
+ schema:
15115
+ $ref: "#/components/schemas/ClaimSetRangeNextTag"
15116
+ 400:
15117
+ description: Bad request
15118
+ 401:
15119
+ description: Unauthorized
15120
+ 404:
15121
+ description: Not found
15122
+ /{rangeId}/resume:
15123
+ post:
15124
+ tags:
15125
+ - ranges
15126
+ summary: Finish minting a range that was interrupted.
15127
+ operationId: ranges_resume
15128
+ security: []
15129
+ parameters:
15130
+ - name: rangeId
15131
+ in: path
15132
+ required: true
15133
+ schema:
15134
+ type: string
15135
+ responses:
15136
+ 200:
15137
+ description: Success
15138
+ content:
15139
+ application/json:
15140
+ schema:
15141
+ $ref: "#/components/schemas/ClaimSetRange"
15142
+ 400:
15143
+ description: Bad request
15144
+ 401:
15145
+ description: Unauthorized
15146
+ 404:
15147
+ description: Not found
15148
+ requestBody:
15149
+ required: true
15150
+ content:
15151
+ application/json:
15152
+ schema:
15153
+ $ref: "#/components/schemas/ClaimSetScope"
15154
+ /{rangeId}/tags:
15155
+ get:
15156
+ tags:
15157
+ - ranges
15158
+ summary: "The range's tags in index order, a page at a time (keys: owners/admins only)."
15159
+ operationId: ranges_tags
15160
+ security: []
15161
+ parameters:
15162
+ - name: rangeId
15163
+ in: path
15164
+ required: true
15165
+ schema:
15166
+ type: string
15167
+ - name: from
15168
+ in: query
15169
+ required: false
15170
+ schema:
15171
+ type: string
15172
+ - name: limit
15173
+ in: query
15174
+ required: false
15175
+ schema:
15176
+ type: string
15177
+ - name: keys
15178
+ in: query
15179
+ required: false
15180
+ schema:
15181
+ type: string
15182
+ responses:
15183
+ 200:
15184
+ description: Success
15185
+ content:
15186
+ application/json:
15187
+ schema:
15188
+ $ref: "#/components/schemas/ClaimSetRangeTagsPage"
15189
+ 400:
15190
+ description: Bad request
15191
+ 401:
15192
+ description: Unauthorized
15193
+ 404:
15194
+ description: Not found
15195
+ /{zone}/collection/{collectionId}/app/{appId}/cases:
15196
+ get:
15197
+ tags:
15198
+ - cases
15199
+ summary: List cases with optional query parameters GET /cases
15200
+ operationId: cases_list
15201
+ security: []
15202
+ parameters:
15203
+ - name: zone
15204
+ in: path
15205
+ required: true
15206
+ schema:
15207
+ type: string
15208
+ - name: collectionId
15209
+ in: path
15210
+ required: true
15211
+ schema:
15212
+ type: string
15213
+ - name: appId
15214
+ in: path
15215
+ required: true
15216
+ schema:
15217
+ type: string
15218
+ - name: category
15219
+ in: query
15220
+ required: false
15221
+ schema:
15222
+ type: string
15223
+ - name: priority
15224
+ in: query
15225
+ required: false
15226
+ schema:
15227
+ type: string
15228
+ - name: ref
15229
+ in: query
15230
+ required: false
15231
+ schema:
15232
+ type: string
15233
+ - name: proofId
15234
+ in: query
15235
+ required: false
15236
+ schema:
15237
+ type: string
15238
+ - name: contactId
15239
+ in: query
15240
+ required: false
15241
+ schema:
15242
+ type: string
15243
+ - name: assignedTo
15244
+ in: query
15245
+ required: false
15246
+ schema:
15247
+ type: string
15248
+ - name: closedAt
15249
+ in: query
15250
+ required: false
15251
+ schema:
15252
+ type: string
15253
+ responses:
15254
+ 200:
15255
+ description: Success
15256
+ content:
15257
+ application/json:
15258
+ schema:
15259
+ type: object
15260
+ additionalProperties: true
15261
+ 400:
15262
+ description: Bad request
15263
+ 401:
15264
+ description: Unauthorized
15265
+ 404:
15266
+ description: Not found
15267
+ post:
15268
+ tags:
15269
+ - cases
15270
+ summary: Create a new case POST /cases
15271
+ operationId: cases_create
15272
+ security: []
15273
+ parameters:
15274
+ - name: zone
15275
+ in: path
15276
+ required: true
15277
+ schema:
15278
+ type: string
15279
+ - name: collectionId
15280
+ in: path
15281
+ required: true
15282
+ schema:
15283
+ type: string
15284
+ - name: appId
15285
+ in: path
15286
+ required: true
15287
+ schema:
15288
+ type: string
15289
+ responses:
15290
+ 200:
15291
+ description: Success
15292
+ content:
15293
+ application/json:
15294
+ schema:
15295
+ $ref: "#/components/schemas/AppCase"
15296
+ 400:
15297
+ description: Bad request
15298
+ 401:
15299
+ description: Unauthorized
15300
+ 404:
15301
+ description: Not found
15302
+ requestBody:
15303
+ required: true
15304
+ content:
15305
+ application/json:
15306
+ schema:
15307
+ $ref: "#/components/schemas/CreateCaseInput"
15308
+ /{zone}/collection/{collectionId}/app/{appId}/cases/aggregate:
15309
+ post:
15310
+ tags:
15311
+ - cases
15312
+ summary: Get aggregate statistics for cases POST /cases/aggregate
15313
+ operationId: cases_aggregate
15314
+ security: []
15315
+ parameters:
15316
+ - name: zone
15317
+ in: path
15318
+ required: true
15319
+ schema:
15320
+ type: string
15321
+ - name: collectionId
15322
+ in: path
15323
+ required: true
15324
+ schema:
15325
+ type: string
15326
+ - name: appId
15327
+ in: path
15328
+ required: true
15329
+ schema:
15330
+ type: string
15331
+ responses:
15332
+ 200:
15333
+ description: Success
15334
+ content:
15335
+ application/json:
15336
+ schema:
15337
+ $ref: "#/components/schemas/AggregateResponse"
15338
+ 400:
15339
+ description: Bad request
15340
+ 401:
15341
+ description: Unauthorized
15342
+ 404:
15343
+ description: Not found
15344
+ requestBody:
15345
+ required: true
15346
+ content:
15347
+ application/json:
15348
+ schema:
15349
+ $ref: "#/components/schemas/AggregateRequest"
15350
+ /{zone}/collection/{collectionId}/app/{appId}/cases/summary:
15351
+ post:
15352
+ tags:
15353
+ - cases
15354
+ summary: Get case summary (admin only) POST /cases/summary
15355
+ operationId: cases_summary
15356
+ security: []
15357
+ parameters:
15358
+ - name: zone
15359
+ in: path
15360
+ required: true
15361
+ schema:
15362
+ type: string
15363
+ - name: collectionId
15364
+ in: path
15365
+ required: true
15366
+ schema:
15367
+ type: string
15368
+ - name: appId
15369
+ in: path
15370
+ required: true
15371
+ schema:
15372
+ type: string
15373
+ responses:
15374
+ 200:
15375
+ description: Success
15376
+ content:
15377
+ application/json:
15378
+ schema:
15379
+ $ref: "#/components/schemas/CaseSummaryResponse"
15380
+ 400:
15381
+ description: Bad request
15382
+ 401:
15383
+ description: Unauthorized
15384
+ 404:
15385
+ description: Not found
15386
+ requestBody:
15387
+ required: true
15388
+ content:
15389
+ application/json:
15390
+ schema:
15391
+ $ref: "#/components/schemas/CaseSummaryRequest"
14934
15392
  /{zone}/collection/{collectionId}/app/{appId}/cases/{caseId}:
14935
15393
  get:
14936
15394
  tags:
@@ -25168,82 +25626,417 @@ components:
25168
25626
  BroadcastAppendEventBody:
25169
25627
  type: object
25170
25628
  properties:
25171
- broadcastId:
25629
+ broadcastId:
25630
+ type: string
25631
+ contactId:
25632
+ type: string
25633
+ channel:
25634
+ $ref: "#/components/schemas/BroadcastChannel"
25635
+ templateId:
25636
+ type: string
25637
+ eventType:
25638
+ type: string
25639
+ outcome:
25640
+ type: string
25641
+ enum:
25642
+ - success
25643
+ - failed
25644
+ failureReason:
25645
+ type: string
25646
+ metadata:
25647
+ type: object
25648
+ additionalProperties: true
25649
+ required:
25650
+ - broadcastId
25651
+ - eventType
25652
+ BroadcastAppendBulkBody:
25653
+ type: object
25654
+ properties:
25655
+ ids:
25656
+ type: array
25657
+ items:
25658
+ type: string
25659
+ idField:
25660
+ type: string
25661
+ params:
25662
+ type: object
25663
+ additionalProperties: true
25664
+ required:
25665
+ - ids
25666
+ - params
25667
+ BroadcastChannel:
25668
+ type: string
25669
+ enum:
25670
+ - email
25671
+ - push
25672
+ - sms
25673
+ - wallet
25674
+ BroadcastPreviewResponse:
25675
+ type: object
25676
+ additionalProperties: true
25677
+ ClaimCodeRef:
25678
+ type: object
25679
+ properties:
25680
+ codeId:
25681
+ type: string
25682
+ claimId:
25683
+ type: string
25684
+ required:
25685
+ - codeId
25686
+ - claimId
25687
+ UpdateClaimDataRequest:
25688
+ type: object
25689
+ properties:
25690
+ data:
25691
+ type: object
25692
+ additionalProperties: true
25693
+ codes:
25694
+ type: array
25695
+ items:
25696
+ $ref: "#/components/schemas/ClaimCodeRef"
25697
+ required:
25698
+ - data
25699
+ - codes
25700
+ AssignClaimsRequest:
25701
+ type: object
25702
+ properties:
25703
+ id:
25704
+ type: string
25705
+ collectionId:
25706
+ type: string
25707
+ productId:
25708
+ type: string
25709
+ batchId:
25710
+ type: string
25711
+ start:
25712
+ type: number
25713
+ end:
25714
+ type: number
25715
+ codeId:
25716
+ type: string
25717
+ data:
25718
+ type: object
25719
+ additionalProperties: true
25720
+ required:
25721
+ - id
25722
+ - collectionId
25723
+ - productId
25724
+ CreateClaimSetTagRequest:
25725
+ type: object
25726
+ properties:
25727
+ id:
25728
+ type: string
25729
+ tagId:
25730
+ type: string
25731
+ productId:
25732
+ type: string
25733
+ collectionId:
25734
+ type: string
25735
+ batchId:
25736
+ type: string
25737
+ password:
25738
+ type: string
25739
+ data:
25740
+ type: object
25741
+ additionalProperties: true
25742
+ CreateClaimSetRequest:
25743
+ type: object
25744
+ properties:
25745
+ name:
25746
+ type: string
25747
+ claimMode:
25748
+ type: string
25749
+ allocationMode:
25750
+ type: string
25751
+ required:
25752
+ - name
25753
+ - claimMode
25754
+ - allocationMode
25755
+ ImportClaimSetTagItem:
25756
+ type: object
25757
+ properties:
25758
+ id:
25759
+ type: string
25760
+ tagId:
25761
+ type: string
25762
+ index:
25763
+ type: number
25764
+ required:
25765
+ - id
25766
+ ImportClaimSetTagsRequest:
25767
+ type: object
25768
+ properties:
25769
+ tags:
25770
+ type: array
25771
+ items:
25772
+ $ref: "#/components/schemas/ImportClaimSetTagItem"
25773
+ mode:
25774
+ type: string
25775
+ enum:
25776
+ - upsert
25777
+ - replace
25778
+ required:
25779
+ - tags
25780
+ ImportClaimSetTagsResponse:
25781
+ type: object
25782
+ properties:
25783
+ written:
25784
+ type: number
25785
+ required:
25786
+ - written
25787
+ CreateClaimSetTagResponse:
25788
+ type: object
25789
+ properties:
25790
+ id:
25791
+ type: string
25792
+ claimSetId:
25793
+ type: string
25794
+ createdAt:
25795
+ type: string
25796
+ tagId:
25797
+ type: string
25798
+ productId:
25799
+ type: string
25800
+ collectionId:
25801
+ type: string
25802
+ batchId:
25803
+ type: string
25804
+ password:
25805
+ type: string
25806
+ data:
25807
+ type: object
25808
+ additionalProperties: true
25809
+ required:
25810
+ - id
25811
+ - claimSetId
25812
+ - createdAt
25813
+ ClaimSetRange:
25814
+ type: object
25815
+ properties:
25816
+ id:
25817
+ type: string
25818
+ claimSetId:
25819
+ type: string
25820
+ namespace:
25821
+ type: string
25822
+ name:
25823
+ type: string
25824
+ notes:
25825
+ type: string
25826
+ startIndex:
25827
+ type: number
25828
+ endIndex:
25829
+ type: number
25830
+ quantity:
25831
+ type: number
25832
+ tagType:
25833
+ $ref: "#/components/schemas/ClaimSetTagType"
25834
+ fulfilment:
25835
+ type: string
25836
+ enum:
25837
+ - printer
25838
+ - sidekick
25839
+ stage:
25840
+ type: string
25841
+ enum:
25842
+ - minting
25843
+ - minted
25844
+ - sent
25845
+ - received
25846
+ status:
25847
+ $ref: "#/components/schemas/ClaimSetRangeStatus"
25848
+ intendedCollectionId:
25849
+ type: string
25850
+ intendedProductId:
25851
+ type: string
25852
+ intendedBatchId:
25853
+ type: string
25854
+ manufacturer:
25855
+ type: string
25856
+ orderRef:
25857
+ type: string
25858
+ counts:
25859
+ type: object
25860
+ additionalProperties: true
25861
+ sentAt:
25862
+ type: string
25863
+ receivedAt:
25864
+ type: string
25865
+ createdBy:
25866
+ type: string
25867
+ createdAt:
25868
+ type: string
25869
+ updatedAt:
25870
+ type: string
25871
+ required:
25872
+ - id
25873
+ - claimSetId
25874
+ - namespace
25875
+ - name
25876
+ - notes
25877
+ - startIndex
25878
+ - endIndex
25879
+ - quantity
25880
+ - tagType
25881
+ - fulfilment
25882
+ - stage
25883
+ - status
25884
+ - intendedCollectionId
25885
+ - intendedProductId
25886
+ - intendedBatchId
25887
+ - manufacturer
25888
+ - orderRef
25889
+ - counts
25890
+ - sentAt
25891
+ - receivedAt
25892
+ - createdBy
25893
+ - createdAt
25894
+ - updatedAt
25895
+ CreateClaimSetRangeRequest:
25896
+ type: object
25897
+ properties:
25898
+ name:
25899
+ type: string
25900
+ quantity:
25901
+ type: number
25902
+ intendedCollectionId:
25903
+ type: string
25904
+ intendedProductId:
25905
+ type: string
25906
+ intendedBatchId:
25907
+ type: string
25908
+ fulfilment:
25909
+ type: string
25910
+ enum:
25911
+ - printer
25912
+ - sidekick
25913
+ notes:
25914
+ type: string
25915
+ manufacturer:
25916
+ type: string
25917
+ orderRef:
25918
+ type: string
25919
+ required:
25920
+ - name
25921
+ - quantity
25922
+ UpdateClaimSetRangeRequest:
25923
+ type: object
25924
+ properties:
25925
+ name:
25172
25926
  type: string
25173
- contactId:
25927
+ notes:
25174
25928
  type: string
25175
- channel:
25176
- $ref: "#/components/schemas/BroadcastChannel"
25177
- templateId:
25929
+ manufacturer:
25178
25930
  type: string
25179
- eventType:
25931
+ orderRef:
25180
25932
  type: string
25181
- outcome:
25933
+ fulfilment:
25182
25934
  type: string
25183
25935
  enum:
25184
- - success
25185
- - failed
25186
- failureReason:
25936
+ - printer
25937
+ - sidekick
25938
+ stage:
25187
25939
  type: string
25188
- metadata:
25189
- type: object
25190
- additionalProperties: true
25940
+ enum:
25941
+ - minted
25942
+ - sent
25943
+ - received
25944
+ ClaimSetRangeTag:
25945
+ type: object
25946
+ properties:
25947
+ code:
25948
+ type: string
25949
+ printed:
25950
+ type: string
25951
+ index:
25952
+ type: number
25953
+ uid:
25954
+ type: string
25955
+ key:
25956
+ type: string
25957
+ collectionId:
25958
+ type: string
25959
+ productId:
25960
+ type: string
25961
+ batchId:
25962
+ type: string
25963
+ proofId:
25964
+ type: string
25965
+ programmedAt:
25966
+ type: string
25967
+ scans:
25968
+ type: number
25191
25969
  required:
25192
- - broadcastId
25193
- - eventType
25194
- BroadcastAppendBulkBody:
25970
+ - code
25971
+ - printed
25972
+ - index
25973
+ - uid
25974
+ - collectionId
25975
+ - productId
25976
+ - batchId
25977
+ - proofId
25978
+ - programmedAt
25979
+ - scans
25980
+ ClaimSetRangeTagsPage:
25195
25981
  type: object
25196
25982
  properties:
25197
- ids:
25983
+ tags:
25198
25984
  type: array
25199
25985
  items:
25200
- type: string
25201
- idField:
25202
- type: string
25203
- params:
25204
- type: object
25205
- additionalProperties: true
25986
+ $ref: "#/components/schemas/ClaimSetRangeTag"
25987
+ next:
25988
+ type: number
25206
25989
  required:
25207
- - ids
25208
- - params
25209
- BroadcastChannel:
25210
- type: string
25211
- enum:
25212
- - email
25213
- - push
25214
- - sms
25215
- - wallet
25216
- BroadcastPreviewResponse:
25217
- type: object
25218
- additionalProperties: true
25219
- ClaimCodeRef:
25990
+ - tags
25991
+ - next
25992
+ ClaimSetRangeNextTag:
25220
25993
  type: object
25221
25994
  properties:
25222
- codeId:
25223
- type: string
25224
- claimId:
25995
+ url:
25225
25996
  type: string
25997
+ piccOffset:
25998
+ type: number
25999
+ mirrorOffset:
26000
+ type: number
26001
+ remaining:
26002
+ type: number
25226
26003
  required:
25227
- - codeId
25228
- - claimId
25229
- UpdateClaimDataRequest:
26004
+ - url
26005
+ - remaining
26006
+ ImportClaimSetRangeUidsRequest:
25230
26007
  type: object
25231
26008
  properties:
25232
- data:
26009
+ csv:
26010
+ type: string
26011
+ rows:
26012
+ type: array
26013
+ items:
26014
+ type: object
26015
+ additionalProperties:
26016
+ type: object
26017
+ additionalProperties: true
26018
+ commit:
26019
+ type: boolean
26020
+ ImportClaimSetRangeUidsResponse:
26021
+ type: object
26022
+ properties:
26023
+ summary:
25233
26024
  type: object
25234
26025
  additionalProperties: true
25235
- codes:
26026
+ rows:
25236
26027
  type: array
25237
26028
  items:
25238
- $ref: "#/components/schemas/ClaimCodeRef"
26029
+ type: object
26030
+ additionalProperties: true
26031
+ range:
26032
+ $ref: "#/components/schemas/ClaimSetRange"
25239
26033
  required:
25240
- - data
25241
- - codes
25242
- AssignClaimsRequest:
26034
+ - summary
26035
+ - rows
26036
+ - range
26037
+ AssignClaimSetRangeRequest:
25243
26038
  type: object
25244
26039
  properties:
25245
- id:
25246
- type: string
25247
26040
  collectionId:
25248
26041
  type: string
25249
26042
  productId:
@@ -25254,104 +26047,183 @@ components:
25254
26047
  type: number
25255
26048
  end:
25256
26049
  type: number
25257
- codeId:
25258
- type: string
26050
+ clear:
26051
+ type: boolean
25259
26052
  data:
25260
26053
  type: object
25261
26054
  additionalProperties: true
26055
+ AssignClaimSetRangeResponse:
26056
+ type: object
26057
+ properties:
26058
+ changed:
26059
+ type: number
26060
+ skipped:
26061
+ type: array
26062
+ items:
26063
+ type: object
26064
+ additionalProperties: true
26065
+ range:
26066
+ $ref: "#/components/schemas/ClaimSetRange"
25262
26067
  required:
25263
- - id
25264
- - collectionId
25265
- - productId
25266
- CreateClaimSetTagRequest:
26068
+ - changed
26069
+ - skipped
26070
+ - range
26071
+ ClaimSetRangeFile:
25267
26072
  type: object
25268
26073
  properties:
25269
- id:
25270
- type: string
25271
- tagId:
26074
+ filename:
25272
26075
  type: string
25273
- productId:
26076
+ contentType:
25274
26077
  type: string
25275
- collectionId:
26078
+ csv:
25276
26079
  type: string
25277
- batchId:
26080
+ base64:
25278
26081
  type: string
25279
- password:
26082
+ markdown:
25280
26083
  type: string
25281
- data:
25282
- type: object
25283
- additionalProperties: true
25284
- CreateClaimSetRequest:
26084
+ required:
26085
+ - filename
26086
+ - contentType
26087
+ Partner:
25285
26088
  type: object
25286
26089
  properties:
26090
+ id:
26091
+ type: string
25287
26092
  name:
25288
26093
  type: string
25289
- claimMode:
26094
+ status:
25290
26095
  type: string
25291
- allocationMode:
26096
+ enum:
26097
+ - active
26098
+ - suspended
26099
+ tapDomains:
26100
+ type: array
26101
+ items:
26102
+ type: string
26103
+ features:
26104
+ type: object
26105
+ additionalProperties:
26106
+ type: boolean
26107
+ role:
26108
+ type: string
26109
+ enum:
26110
+ - owner
26111
+ - admin
26112
+ - assigner
26113
+ members:
26114
+ type: array
26115
+ items:
26116
+ type: object
26117
+ additionalProperties: true
26118
+ createdAt:
26119
+ type: string
26120
+ updatedAt:
25292
26121
  type: string
25293
26122
  required:
26123
+ - id
25294
26124
  - name
25295
- - claimMode
25296
- - allocationMode
25297
- ImportClaimSetTagItem:
26125
+ - status
26126
+ - tapDomains
26127
+ - features
26128
+ - createdAt
26129
+ - updatedAt
26130
+ PartnerClaimSet:
25298
26131
  type: object
25299
26132
  properties:
25300
26133
  id:
25301
26134
  type: string
25302
- tagId:
26135
+ namespace:
25303
26136
  type: string
25304
- index:
26137
+ name:
26138
+ type: string
26139
+ tagType:
26140
+ $ref: "#/components/schemas/ClaimSetTagType"
26141
+ tapDomain:
26142
+ type: string
26143
+ owner:
26144
+ type: object
26145
+ additionalProperties: true
26146
+ codes:
25305
26147
  type: number
26148
+ deleted:
26149
+ type: boolean
26150
+ createdAt:
26151
+ type: string
25306
26152
  required:
25307
26153
  - id
25308
- ImportClaimSetTagsRequest:
26154
+ - namespace
26155
+ - name
26156
+ - tagType
26157
+ - tapDomain
26158
+ - owner
26159
+ - codes
26160
+ - deleted
26161
+ - createdAt
26162
+ PartnerTagHit:
25309
26163
  type: object
25310
26164
  properties:
25311
- tags:
25312
- type: array
25313
- items:
25314
- $ref: "#/components/schemas/ImportClaimSetTagItem"
25315
- mode:
26165
+ namespace:
25316
26166
  type: string
25317
- enum:
25318
- - upsert
25319
- - replace
26167
+ claimSetId:
26168
+ type: string
26169
+ set:
26170
+ $ref: "#/components/schemas/PartnerClaimSet"
26171
+ tag:
26172
+ $ref: "#/components/schemas/ClaimSetRangeTag"
26173
+ range:
26174
+ $ref: "#/components/schemas/ClaimSetRange"
25320
26175
  required:
25321
- - tags
25322
- ImportClaimSetTagsResponse:
26176
+ - namespace
26177
+ - claimSetId
26178
+ - set
26179
+ - tag
26180
+ - range
26181
+ CreatePartnerClaimSetRequest:
25323
26182
  type: object
25324
26183
  properties:
25325
- written:
25326
- type: number
26184
+ name:
26185
+ type: string
26186
+ tagType:
26187
+ $ref: "#/components/schemas/ClaimSetTagType"
26188
+ tapDomain:
26189
+ type: string
25327
26190
  required:
25328
- - written
25329
- CreateClaimSetTagResponse:
26191
+ - name
26192
+ - tagType
26193
+ ClaimSetScope:
25330
26194
  type: object
25331
26195
  properties:
25332
- id:
25333
- type: string
25334
- claimSetId:
25335
- type: string
25336
- createdAt:
25337
- type: string
25338
- tagId:
25339
- type: string
25340
- productId:
25341
- type: string
25342
26196
  collectionId:
25343
26197
  type: string
25344
- batchId:
25345
- type: string
25346
- password:
25347
- type: string
25348
- data:
25349
- type: object
25350
- additionalProperties: true
25351
26198
  required:
25352
- - id
25353
- - claimSetId
25354
- - createdAt
26199
+ - collectionId
26200
+ ClaimSetTagType:
26201
+ type: string
26202
+ enum:
26203
+ - ntag424
26204
+ - ntag21x
26205
+ - qr
26206
+ ClaimSetRangeStatus:
26207
+ type: string
26208
+ enum:
26209
+ - minting
26210
+ - minted
26211
+ - sent
26212
+ - received
26213
+ - assigned
26214
+ ClaimSetImportResult:
26215
+ type: string
26216
+ enum:
26217
+ - ok
26218
+ - unchanged
26219
+ - unknown_code
26220
+ - duplicate_row
26221
+ - index_mismatch
26222
+ - no_uid
26223
+ - bad_uid
26224
+ - duplicate_uid
26225
+ - uid_in_use
26226
+ - uid_conflict
25355
26227
  Collection:
25356
26228
  type: object
25357
26229
  properties:
@@ -30510,6 +31382,10 @@ components:
30510
31382
  type: string
30511
31383
  mirror:
30512
31384
  type: string
31385
+ d:
31386
+ type: string
31387
+ c:
31388
+ type: string
30513
31389
  userId:
30514
31390
  type: string
30515
31391
  required: