@proveanything/smartlinks 1.15.3 → 1.15.5
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/appConfiguration.d.ts +90 -1
- package/dist/api/appConfiguration.js +117 -0
- package/dist/api/collection.d.ts +6 -2
- package/dist/api/collection.js +6 -2
- package/dist/cache.d.ts +19 -0
- package/dist/cache.js +25 -0
- package/dist/docs/API_SUMMARY.md +157 -11
- package/dist/docs/app-data-storage.md +2 -0
- package/dist/docs/appConfig.md +483 -0
- package/dist/docs/overview.md +20 -0
- package/dist/docs/proof-product-data-scoping.md +459 -0
- package/dist/openapi.yaml +222 -4
- package/dist/types/appConfiguration.d.ts +83 -0
- package/dist/types/collection.d.ts +11 -2
- package/dist/types/product.d.ts +37 -0
- package/dist/types/proof.d.ts +39 -3
- package/docs/API_SUMMARY.md +157 -11
- package/docs/app-data-storage.md +2 -0
- package/docs/appConfig.md +483 -0
- package/docs/overview.md +20 -0
- package/docs/proof-product-data-scoping.md +459 -0
- package/openapi.yaml +222 -4
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -9602,7 +9602,7 @@ paths:
|
|
|
9602
9602
|
get:
|
|
9603
9603
|
tags:
|
|
9604
9604
|
- collection
|
|
9605
|
-
summary: Retrieve all configured app module definitions for a collection (public endpoint).
|
|
9605
|
+
summary: "Retrieve all configured app module definitions for a collection (public endpoint), plus the collection's `appConfig` entitlements data (`system.features`, `system.meters`, `entitledAppGroups`, `itemRecordMode`, etc.) in the same response."
|
|
9606
9606
|
operationId: collection_getAppsConfig
|
|
9607
9607
|
security: []
|
|
9608
9608
|
parameters:
|
|
@@ -15592,6 +15592,140 @@ components:
|
|
|
15592
15592
|
required:
|
|
15593
15593
|
- id
|
|
15594
15594
|
- name
|
|
15595
|
+
AppEntry:
|
|
15596
|
+
type: object
|
|
15597
|
+
properties:
|
|
15598
|
+
id:
|
|
15599
|
+
type: string
|
|
15600
|
+
uniqueName:
|
|
15601
|
+
type: string
|
|
15602
|
+
customName:
|
|
15603
|
+
type: string
|
|
15604
|
+
active:
|
|
15605
|
+
type: boolean
|
|
15606
|
+
all:
|
|
15607
|
+
type: boolean
|
|
15608
|
+
live:
|
|
15609
|
+
type: boolean
|
|
15610
|
+
faIcon:
|
|
15611
|
+
type: string
|
|
15612
|
+
versionChannel:
|
|
15613
|
+
type: string
|
|
15614
|
+
enum:
|
|
15615
|
+
- stable
|
|
15616
|
+
- beta
|
|
15617
|
+
- dev
|
|
15618
|
+
reason:
|
|
15619
|
+
type: string
|
|
15620
|
+
enum:
|
|
15621
|
+
- not_entitled
|
|
15622
|
+
required:
|
|
15623
|
+
- id
|
|
15624
|
+
- uniqueName
|
|
15625
|
+
- active
|
|
15626
|
+
MeterEntry:
|
|
15627
|
+
type: object
|
|
15628
|
+
properties:
|
|
15629
|
+
included:
|
|
15630
|
+
type: number
|
|
15631
|
+
stripePriceId:
|
|
15632
|
+
type: string
|
|
15633
|
+
stripeMeterId:
|
|
15634
|
+
type: string
|
|
15635
|
+
required:
|
|
15636
|
+
- included
|
|
15637
|
+
AppliedOverridesSummary:
|
|
15638
|
+
type: object
|
|
15639
|
+
properties:
|
|
15640
|
+
features:
|
|
15641
|
+
type: array
|
|
15642
|
+
items:
|
|
15643
|
+
type: string
|
|
15644
|
+
meters:
|
|
15645
|
+
type: array
|
|
15646
|
+
items:
|
|
15647
|
+
type: string
|
|
15648
|
+
entitledAppGroups:
|
|
15649
|
+
type: array
|
|
15650
|
+
items:
|
|
15651
|
+
type: string
|
|
15652
|
+
addOnKeys:
|
|
15653
|
+
type: array
|
|
15654
|
+
items:
|
|
15655
|
+
type: string
|
|
15656
|
+
apps:
|
|
15657
|
+
type: array
|
|
15658
|
+
items:
|
|
15659
|
+
type: string
|
|
15660
|
+
accountType:
|
|
15661
|
+
type: boolean
|
|
15662
|
+
note:
|
|
15663
|
+
type: string
|
|
15664
|
+
SystemBlock:
|
|
15665
|
+
type: object
|
|
15666
|
+
properties:
|
|
15667
|
+
basePlanId:
|
|
15668
|
+
type: string
|
|
15669
|
+
addOnKeys:
|
|
15670
|
+
type: array
|
|
15671
|
+
items:
|
|
15672
|
+
type: string
|
|
15673
|
+
apps:
|
|
15674
|
+
type: array
|
|
15675
|
+
items:
|
|
15676
|
+
type: string
|
|
15677
|
+
features:
|
|
15678
|
+
type: object
|
|
15679
|
+
additionalProperties:
|
|
15680
|
+
type: boolean
|
|
15681
|
+
meters:
|
|
15682
|
+
type: object
|
|
15683
|
+
additionalProperties:
|
|
15684
|
+
$ref: "#/components/schemas/MeterEntry"
|
|
15685
|
+
entitledAppGroups:
|
|
15686
|
+
type: array
|
|
15687
|
+
items:
|
|
15688
|
+
type: string
|
|
15689
|
+
accountType:
|
|
15690
|
+
type: string
|
|
15691
|
+
enum:
|
|
15692
|
+
- enterprise
|
|
15693
|
+
- standard
|
|
15694
|
+
syncedAt:
|
|
15695
|
+
type: string
|
|
15696
|
+
syncedFromSubscriptionId:
|
|
15697
|
+
type: string
|
|
15698
|
+
appliedOverrides:
|
|
15699
|
+
$ref: "#/components/schemas/AppliedOverridesSummary"
|
|
15700
|
+
AppConfigSettings:
|
|
15701
|
+
type: object
|
|
15702
|
+
properties:
|
|
15703
|
+
id:
|
|
15704
|
+
type: string
|
|
15705
|
+
enum:
|
|
15706
|
+
- appConfig
|
|
15707
|
+
apps:
|
|
15708
|
+
type: array
|
|
15709
|
+
items:
|
|
15710
|
+
$ref: "#/components/schemas/AppEntry"
|
|
15711
|
+
addOns:
|
|
15712
|
+
type: array
|
|
15713
|
+
items:
|
|
15714
|
+
type: string
|
|
15715
|
+
requestedBasePlanId:
|
|
15716
|
+
type: string
|
|
15717
|
+
itemRecordMode:
|
|
15718
|
+
type: string
|
|
15719
|
+
enum:
|
|
15720
|
+
- registered
|
|
15721
|
+
- owned
|
|
15722
|
+
virtualItemsEnabled:
|
|
15723
|
+
type: boolean
|
|
15724
|
+
system:
|
|
15725
|
+
$ref: "#/components/schemas/SystemBlock"
|
|
15726
|
+
required:
|
|
15727
|
+
- id
|
|
15728
|
+
- apps
|
|
15595
15729
|
AppBundle:
|
|
15596
15730
|
type: object
|
|
15597
15731
|
properties:
|
|
@@ -24084,6 +24218,67 @@ components:
|
|
|
24084
24218
|
$ref: "#/components/schemas/JsonValue"
|
|
24085
24219
|
required:
|
|
24086
24220
|
- claimId
|
|
24221
|
+
ScopedFieldOption:
|
|
24222
|
+
type: object
|
|
24223
|
+
properties:
|
|
24224
|
+
value:
|
|
24225
|
+
type: string
|
|
24226
|
+
label:
|
|
24227
|
+
type: string
|
|
24228
|
+
required:
|
|
24229
|
+
- value
|
|
24230
|
+
- label
|
|
24231
|
+
ScopedFieldDef:
|
|
24232
|
+
type: object
|
|
24233
|
+
properties:
|
|
24234
|
+
key:
|
|
24235
|
+
type: string
|
|
24236
|
+
label:
|
|
24237
|
+
type: string
|
|
24238
|
+
type:
|
|
24239
|
+
$ref: "#/components/schemas/ScopedFieldType"
|
|
24240
|
+
required:
|
|
24241
|
+
type: boolean
|
|
24242
|
+
placeholder:
|
|
24243
|
+
type: string
|
|
24244
|
+
help:
|
|
24245
|
+
type: string
|
|
24246
|
+
options:
|
|
24247
|
+
type: array
|
|
24248
|
+
items:
|
|
24249
|
+
$ref: "#/components/schemas/ScopedFieldOption"
|
|
24250
|
+
defaultValue:
|
|
24251
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24252
|
+
showInTable:
|
|
24253
|
+
type: boolean
|
|
24254
|
+
showInDetail:
|
|
24255
|
+
type: boolean
|
|
24256
|
+
required:
|
|
24257
|
+
- key
|
|
24258
|
+
- label
|
|
24259
|
+
- type
|
|
24260
|
+
ProductFieldsConfig:
|
|
24261
|
+
type: object
|
|
24262
|
+
properties:
|
|
24263
|
+
fields:
|
|
24264
|
+
type: array
|
|
24265
|
+
items:
|
|
24266
|
+
$ref: "#/components/schemas/ProductFieldDef"
|
|
24267
|
+
required:
|
|
24268
|
+
- fields
|
|
24269
|
+
ProofValues:
|
|
24270
|
+
type: object
|
|
24271
|
+
properties:
|
|
24272
|
+
owner:
|
|
24273
|
+
type: object
|
|
24274
|
+
additionalProperties:
|
|
24275
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24276
|
+
personal:
|
|
24277
|
+
type: object
|
|
24278
|
+
additionalProperties:
|
|
24279
|
+
type: object
|
|
24280
|
+
additionalProperties:
|
|
24281
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24087
24282
|
Proof:
|
|
24088
24283
|
type: object
|
|
24089
24284
|
properties:
|
|
@@ -24103,9 +24298,16 @@ components:
|
|
|
24103
24298
|
type: boolean
|
|
24104
24299
|
virtual:
|
|
24105
24300
|
type: boolean
|
|
24106
|
-
|
|
24301
|
+
data:
|
|
24107
24302
|
type: object
|
|
24108
|
-
additionalProperties:
|
|
24303
|
+
additionalProperties:
|
|
24304
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24305
|
+
admin:
|
|
24306
|
+
type: object
|
|
24307
|
+
additionalProperties:
|
|
24308
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24309
|
+
values:
|
|
24310
|
+
$ref: "#/components/schemas/ProofValues"
|
|
24109
24311
|
required:
|
|
24110
24312
|
- collectionId
|
|
24111
24313
|
- createdAt
|
|
@@ -24118,14 +24320,30 @@ components:
|
|
|
24118
24320
|
type: object
|
|
24119
24321
|
properties:
|
|
24120
24322
|
values:
|
|
24323
|
+
$ref: "#/components/schemas/ProofValues"
|
|
24324
|
+
data:
|
|
24121
24325
|
type: object
|
|
24122
|
-
additionalProperties:
|
|
24326
|
+
additionalProperties:
|
|
24327
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24328
|
+
admin:
|
|
24329
|
+
type: object
|
|
24330
|
+
additionalProperties:
|
|
24331
|
+
$ref: "#/components/schemas/JsonValue"
|
|
24123
24332
|
claimable:
|
|
24124
24333
|
type: boolean
|
|
24125
24334
|
virtual:
|
|
24126
24335
|
type: boolean
|
|
24127
24336
|
required:
|
|
24128
24337
|
- values
|
|
24338
|
+
ProofFieldsConfig:
|
|
24339
|
+
type: object
|
|
24340
|
+
properties:
|
|
24341
|
+
fields:
|
|
24342
|
+
type: array
|
|
24343
|
+
items:
|
|
24344
|
+
$ref: "#/components/schemas/ProofFieldDef"
|
|
24345
|
+
required:
|
|
24346
|
+
- fields
|
|
24129
24347
|
ProofResponse:
|
|
24130
24348
|
type: object
|
|
24131
24349
|
additionalProperties: true
|