@proveanything/smartlinks 1.15.0 → 1.15.2
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/collection.d.ts +69 -1
- package/dist/api/collection.js +94 -0
- package/dist/api/facets.d.ts +3 -1
- package/dist/api/facets.js +10 -0
- package/dist/docs/API_SUMMARY.md +47 -1
- package/dist/docs/PRODUCT_FACETS_SDK.md +43 -1
- package/dist/http.js +3 -1
- package/dist/index.d.ts +2 -2
- package/dist/openapi.yaml +258 -0
- package/dist/types/collection.d.ts +19 -0
- package/dist/types/facets.d.ts +8 -0
- package/docs/API_SUMMARY.md +47 -1
- package/docs/PRODUCT_FACETS_SDK.md +43 -1
- package/openapi.yaml +258 -0
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -3337,6 +3337,63 @@ paths:
|
|
|
3337
3337
|
description: Unauthorized
|
|
3338
3338
|
404:
|
|
3339
3339
|
description: Not found
|
|
3340
|
+
/admin/collection/{collectionId}/domain:
|
|
3341
|
+
get:
|
|
3342
|
+
tags:
|
|
3343
|
+
- collection
|
|
3344
|
+
summary: "Get the managed-certificate status for a collection's custom domain (admin only)."
|
|
3345
|
+
operationId: collection_getDomainStatus
|
|
3346
|
+
security:
|
|
3347
|
+
- bearerAuth: []
|
|
3348
|
+
parameters:
|
|
3349
|
+
- name: collectionId
|
|
3350
|
+
in: path
|
|
3351
|
+
required: true
|
|
3352
|
+
schema:
|
|
3353
|
+
type: string
|
|
3354
|
+
responses:
|
|
3355
|
+
200:
|
|
3356
|
+
description: Success
|
|
3357
|
+
content:
|
|
3358
|
+
application/json:
|
|
3359
|
+
schema: {}
|
|
3360
|
+
400:
|
|
3361
|
+
description: Bad request
|
|
3362
|
+
401:
|
|
3363
|
+
description: Unauthorized
|
|
3364
|
+
404:
|
|
3365
|
+
description: Not found
|
|
3366
|
+
post:
|
|
3367
|
+
tags:
|
|
3368
|
+
- collection
|
|
3369
|
+
summary: Register a custom domain for a collection and provision its managed certificate (admin only).
|
|
3370
|
+
operationId: collection_registerDomain
|
|
3371
|
+
security:
|
|
3372
|
+
- bearerAuth: []
|
|
3373
|
+
parameters:
|
|
3374
|
+
- name: collectionId
|
|
3375
|
+
in: path
|
|
3376
|
+
required: true
|
|
3377
|
+
schema:
|
|
3378
|
+
type: string
|
|
3379
|
+
responses:
|
|
3380
|
+
200:
|
|
3381
|
+
description: Success
|
|
3382
|
+
content:
|
|
3383
|
+
application/json:
|
|
3384
|
+
schema: {}
|
|
3385
|
+
400:
|
|
3386
|
+
description: Bad request
|
|
3387
|
+
401:
|
|
3388
|
+
description: Unauthorized
|
|
3389
|
+
404:
|
|
3390
|
+
description: Not found
|
|
3391
|
+
requestBody:
|
|
3392
|
+
required: true
|
|
3393
|
+
content:
|
|
3394
|
+
application/json:
|
|
3395
|
+
schema:
|
|
3396
|
+
$ref: "#/components/schemas/DomainTarget"
|
|
3340
3397
|
/admin/collection/{collectionId}/facets:
|
|
3341
3398
|
get:
|
|
3342
3399
|
tags:
|
|
@@ -3372,6 +3429,11 @@ paths:
|
|
|
3372
3429
|
required: false
|
|
3373
3430
|
schema:
|
|
3374
3431
|
type: boolean
|
|
3432
|
+
- name: namespace
|
|
3433
|
+
in: query
|
|
3434
|
+
required: false
|
|
3435
|
+
schema:
|
|
3436
|
+
type: string
|
|
3375
3437
|
responses:
|
|
3376
3438
|
200:
|
|
3377
3439
|
description: Success
|
|
@@ -3417,6 +3479,33 @@ paths:
|
|
|
3417
3479
|
application/json:
|
|
3418
3480
|
schema:
|
|
3419
3481
|
$ref: "#/components/schemas/FacetDefinitionWriteInput"
|
|
3482
|
+
/admin/collection/{collectionId}/facets/namespaces:
|
|
3483
|
+
get:
|
|
3484
|
+
tags:
|
|
3485
|
+
- facets
|
|
3486
|
+
summary: facets.namespaces
|
|
3487
|
+
operationId: facets_namespaces
|
|
3488
|
+
security:
|
|
3489
|
+
- bearerAuth: []
|
|
3490
|
+
parameters:
|
|
3491
|
+
- name: collectionId
|
|
3492
|
+
in: path
|
|
3493
|
+
required: true
|
|
3494
|
+
schema:
|
|
3495
|
+
type: string
|
|
3496
|
+
responses:
|
|
3497
|
+
200:
|
|
3498
|
+
description: Success
|
|
3499
|
+
content:
|
|
3500
|
+
application/json:
|
|
3501
|
+
schema:
|
|
3502
|
+
$ref: "#/components/schemas/FacetNamespaceListResponse"
|
|
3503
|
+
400:
|
|
3504
|
+
description: Bad request
|
|
3505
|
+
401:
|
|
3506
|
+
description: Unauthorized
|
|
3507
|
+
404:
|
|
3508
|
+
description: Not found
|
|
3420
3509
|
/admin/collection/{collectionId}/facets/query:
|
|
3421
3510
|
post:
|
|
3422
3511
|
tags:
|
|
@@ -3871,6 +3960,60 @@ paths:
|
|
|
3871
3960
|
description: Unauthorized
|
|
3872
3961
|
404:
|
|
3873
3962
|
description: Not found
|
|
3963
|
+
/admin/collection/{collectionId}/hub:
|
|
3964
|
+
post:
|
|
3965
|
+
tags:
|
|
3966
|
+
- collection
|
|
3967
|
+
summary: Claim or rename the Hub subdomain for a collection (admin only).
|
|
3968
|
+
operationId: collection_claimHub
|
|
3969
|
+
security:
|
|
3970
|
+
- bearerAuth: []
|
|
3971
|
+
parameters:
|
|
3972
|
+
- name: collectionId
|
|
3973
|
+
in: path
|
|
3974
|
+
required: true
|
|
3975
|
+
schema:
|
|
3976
|
+
type: string
|
|
3977
|
+
responses:
|
|
3978
|
+
200:
|
|
3979
|
+
description: Success
|
|
3980
|
+
content:
|
|
3981
|
+
application/json:
|
|
3982
|
+
schema:
|
|
3983
|
+
$ref: "#/components/schemas/CollectionResponse"
|
|
3984
|
+
400:
|
|
3985
|
+
description: Bad request
|
|
3986
|
+
401:
|
|
3987
|
+
description: Unauthorized
|
|
3988
|
+
404:
|
|
3989
|
+
description: Not found
|
|
3990
|
+
/admin/collection/{collectionId}/hub/available:
|
|
3991
|
+
get:
|
|
3992
|
+
tags:
|
|
3993
|
+
- collection
|
|
3994
|
+
summary: Check whether a Hub subdomain name is available to claim (admin only).
|
|
3995
|
+
operationId: collection_checkHubAvailability
|
|
3996
|
+
security:
|
|
3997
|
+
- bearerAuth: []
|
|
3998
|
+
parameters:
|
|
3999
|
+
- name: collectionId
|
|
4000
|
+
in: path
|
|
4001
|
+
required: true
|
|
4002
|
+
schema:
|
|
4003
|
+
type: string
|
|
4004
|
+
responses:
|
|
4005
|
+
200:
|
|
4006
|
+
description: Success
|
|
4007
|
+
content:
|
|
4008
|
+
application/json:
|
|
4009
|
+
schema:
|
|
4010
|
+
$ref: "#/components/schemas/HubAvailabilityResponse"
|
|
4011
|
+
400:
|
|
4012
|
+
description: Bad request
|
|
4013
|
+
401:
|
|
4014
|
+
description: Unauthorized
|
|
4015
|
+
404:
|
|
4016
|
+
description: Not found
|
|
3874
4017
|
/admin/collection/{collectionId}/interactions:
|
|
3875
4018
|
get:
|
|
3876
4019
|
tags:
|
|
@@ -9205,6 +9348,52 @@ paths:
|
|
|
9205
9348
|
application/json:
|
|
9206
9349
|
schema:
|
|
9207
9350
|
$ref: "#/components/schemas/RequestUploadTokenOptions"
|
|
9351
|
+
/public/collection/by-domain/{domain}:
|
|
9352
|
+
get:
|
|
9353
|
+
tags:
|
|
9354
|
+
- collection
|
|
9355
|
+
summary: Resolve the collection for an explicit Hub domain (public endpoint).
|
|
9356
|
+
operationId: collection_getByDomain
|
|
9357
|
+
security: []
|
|
9358
|
+
parameters:
|
|
9359
|
+
- name: domain
|
|
9360
|
+
in: path
|
|
9361
|
+
required: true
|
|
9362
|
+
schema:
|
|
9363
|
+
type: string
|
|
9364
|
+
responses:
|
|
9365
|
+
200:
|
|
9366
|
+
description: Success
|
|
9367
|
+
content:
|
|
9368
|
+
application/json:
|
|
9369
|
+
schema:
|
|
9370
|
+
$ref: "#/components/schemas/CollectionResponse"
|
|
9371
|
+
400:
|
|
9372
|
+
description: Bad request
|
|
9373
|
+
401:
|
|
9374
|
+
description: Unauthorized
|
|
9375
|
+
404:
|
|
9376
|
+
description: Not found
|
|
9377
|
+
/public/collection/getByHub:
|
|
9378
|
+
get:
|
|
9379
|
+
tags:
|
|
9380
|
+
- collection
|
|
9381
|
+
summary: Resolve the collection for the current Hub domain (public endpoint).
|
|
9382
|
+
operationId: collection_getByHub
|
|
9383
|
+
security: []
|
|
9384
|
+
responses:
|
|
9385
|
+
200:
|
|
9386
|
+
description: Success
|
|
9387
|
+
content:
|
|
9388
|
+
application/json:
|
|
9389
|
+
schema:
|
|
9390
|
+
$ref: "#/components/schemas/CollectionResponse"
|
|
9391
|
+
400:
|
|
9392
|
+
description: Bad request
|
|
9393
|
+
401:
|
|
9394
|
+
description: Unauthorized
|
|
9395
|
+
404:
|
|
9396
|
+
description: Not found
|
|
9208
9397
|
/public/collection/getShortId/{shortId}:
|
|
9209
9398
|
get:
|
|
9210
9399
|
tags:
|
|
@@ -10680,6 +10869,11 @@ paths:
|
|
|
10680
10869
|
required: false
|
|
10681
10870
|
schema:
|
|
10682
10871
|
type: boolean
|
|
10872
|
+
- name: namespace
|
|
10873
|
+
in: query
|
|
10874
|
+
required: false
|
|
10875
|
+
schema:
|
|
10876
|
+
type: string
|
|
10683
10877
|
responses:
|
|
10684
10878
|
200:
|
|
10685
10879
|
description: Success
|
|
@@ -10693,6 +10887,32 @@ paths:
|
|
|
10693
10887
|
description: Unauthorized
|
|
10694
10888
|
404:
|
|
10695
10889
|
description: Not found
|
|
10890
|
+
/public/collection/{collectionId}/facets/namespaces:
|
|
10891
|
+
get:
|
|
10892
|
+
tags:
|
|
10893
|
+
- facets
|
|
10894
|
+
summary: facets.publicNamespaces
|
|
10895
|
+
operationId: facets_publicNamespaces
|
|
10896
|
+
security: []
|
|
10897
|
+
parameters:
|
|
10898
|
+
- name: collectionId
|
|
10899
|
+
in: path
|
|
10900
|
+
required: true
|
|
10901
|
+
schema:
|
|
10902
|
+
type: string
|
|
10903
|
+
responses:
|
|
10904
|
+
200:
|
|
10905
|
+
description: Success
|
|
10906
|
+
content:
|
|
10907
|
+
application/json:
|
|
10908
|
+
schema:
|
|
10909
|
+
$ref: "#/components/schemas/FacetNamespaceListResponse"
|
|
10910
|
+
400:
|
|
10911
|
+
description: Bad request
|
|
10912
|
+
401:
|
|
10913
|
+
description: Unauthorized
|
|
10914
|
+
404:
|
|
10915
|
+
description: Not found
|
|
10696
10916
|
/public/collection/{collectionId}/facets/query:
|
|
10697
10917
|
post:
|
|
10698
10918
|
tags:
|
|
@@ -10748,6 +10968,11 @@ paths:
|
|
|
10748
10968
|
required: false
|
|
10749
10969
|
schema:
|
|
10750
10970
|
type: boolean
|
|
10971
|
+
- name: namespace
|
|
10972
|
+
in: query
|
|
10973
|
+
required: false
|
|
10974
|
+
schema:
|
|
10975
|
+
type: string
|
|
10751
10976
|
responses:
|
|
10752
10977
|
200:
|
|
10753
10978
|
description: Success
|
|
@@ -18908,6 +19133,10 @@ components:
|
|
|
18908
19133
|
type: string
|
|
18909
19134
|
redirectUrl:
|
|
18910
19135
|
type: string
|
|
19136
|
+
hubName:
|
|
19137
|
+
type: string
|
|
19138
|
+
hubCustomDomain:
|
|
19139
|
+
type: string
|
|
18911
19140
|
shortId:
|
|
18912
19141
|
type: string
|
|
18913
19142
|
dark:
|
|
@@ -18942,6 +19171,16 @@ components:
|
|
|
18942
19171
|
- variants
|
|
18943
19172
|
- batches
|
|
18944
19173
|
- defaultAuthKitId
|
|
19174
|
+
HubAvailabilityResponse:
|
|
19175
|
+
type: object
|
|
19176
|
+
properties:
|
|
19177
|
+
available:
|
|
19178
|
+
type: boolean
|
|
19179
|
+
domain:
|
|
19180
|
+
type: string
|
|
19181
|
+
required:
|
|
19182
|
+
- available
|
|
19183
|
+
- domain
|
|
18945
19184
|
AppConfig:
|
|
18946
19185
|
type: object
|
|
18947
19186
|
properties:
|
|
@@ -20552,6 +20791,8 @@ components:
|
|
|
20552
20791
|
type: string
|
|
20553
20792
|
description:
|
|
20554
20793
|
type: string
|
|
20794
|
+
namespace:
|
|
20795
|
+
type: string
|
|
20555
20796
|
cardinality:
|
|
20556
20797
|
type: object
|
|
20557
20798
|
additionalProperties: true
|
|
@@ -20647,6 +20888,8 @@ components:
|
|
|
20647
20888
|
type: string
|
|
20648
20889
|
description:
|
|
20649
20890
|
type: string
|
|
20891
|
+
namespace:
|
|
20892
|
+
type: string
|
|
20650
20893
|
cardinality:
|
|
20651
20894
|
type: object
|
|
20652
20895
|
additionalProperties: true
|
|
@@ -20742,6 +20985,8 @@ components:
|
|
|
20742
20985
|
type: boolean
|
|
20743
20986
|
includeDeleted:
|
|
20744
20987
|
type: boolean
|
|
20988
|
+
namespace:
|
|
20989
|
+
type: string
|
|
20745
20990
|
query:
|
|
20746
20991
|
type: object
|
|
20747
20992
|
additionalProperties: true
|
|
@@ -20809,11 +21054,24 @@ components:
|
|
|
20809
21054
|
additionalProperties: true
|
|
20810
21055
|
reserved:
|
|
20811
21056
|
type: boolean
|
|
21057
|
+
namespace:
|
|
21058
|
+
type: string
|
|
20812
21059
|
PublicFacetListParams:
|
|
20813
21060
|
type: object
|
|
20814
21061
|
properties:
|
|
20815
21062
|
includeValues:
|
|
20816
21063
|
type: boolean
|
|
21064
|
+
namespace:
|
|
21065
|
+
type: string
|
|
21066
|
+
FacetNamespaceListResponse:
|
|
21067
|
+
type: object
|
|
21068
|
+
properties:
|
|
21069
|
+
namespaces:
|
|
21070
|
+
type: array
|
|
21071
|
+
items:
|
|
21072
|
+
type: string
|
|
21073
|
+
required:
|
|
21074
|
+
- namespaces
|
|
20817
21075
|
FacetGetParams:
|
|
20818
21076
|
type: object
|
|
20819
21077
|
properties:
|