@proveanything/smartlinks 1.7.5 → 1.7.8

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/openapi.yaml CHANGED
@@ -7,13 +7,14 @@ servers:
7
7
  - url: "https://smartlinks.app/api/v1"
8
8
  description: Production
9
9
  tags:
10
+ - name: responses
10
11
  - name: completions
11
12
  - name: models
12
13
  - name: rag
13
14
  - name: sessions
14
15
  - name: podcast
15
16
  - name: tts
16
- - name: publicApi
17
+ - name: publicClient
17
18
  - name: voice
18
19
  - name: userAppData
19
20
  - name: appConfiguration
@@ -691,7 +692,7 @@ paths:
691
692
  post:
692
693
  tags:
693
694
  - rag
694
- summary: "List available AI models / export async function list(collectionId: string): Promise<{ object: 'list'; data: AIModel[] }"
695
+ summary: "List available AI models / export async function list(collectionId: string, params?: AIModelListParams): Promise<AIModel"
695
696
  operationId: rag_indexDocument
696
697
  security:
697
698
  - bearerAuth: []
@@ -720,11 +721,38 @@ paths:
720
721
  application/json:
721
722
  schema:
722
723
  $ref: "#/components/schemas/IndexDocumentRequest"
724
+ /admin/collection/{collectionId}/ai/models)}:
725
+ get:
726
+ tags:
727
+ - models
728
+ summary: List available AI models
729
+ operationId: models_list
730
+ security:
731
+ - bearerAuth: []
732
+ parameters:
733
+ - name: collectionId
734
+ in: path
735
+ required: true
736
+ schema:
737
+ type: string
738
+ responses:
739
+ 200:
740
+ description: Success
741
+ content:
742
+ application/json:
743
+ schema:
744
+ $ref: "#/components/schemas/AIModelListResponse"
745
+ 400:
746
+ description: Bad request
747
+ 401:
748
+ description: Unauthorized
749
+ 404:
750
+ description: Not found
723
751
  /admin/collection/{collectionId}/ai/models/{modelId}:
724
752
  get:
725
753
  tags:
726
754
  - models
727
- summary: "List available AI models / export async function list(collectionId: string): Promise<{ object: 'list'; data: AIModel[] }"
755
+ summary: "List available AI models / export async function list(collectionId: string, params?: AIModelListParams): Promise<AIModel"
728
756
  operationId: models_get
729
757
  security:
730
758
  - bearerAuth: []
@@ -938,6 +966,39 @@ paths:
938
966
  application/json:
939
967
  schema:
940
968
  $ref: "#/components/schemas/ChatCompletionRequest"
969
+ /admin/collection/{collectionId}/ai/v1/responses:
970
+ post:
971
+ tags:
972
+ - responses
973
+ summary: Create a Responses API request (streaming or non-streaming)
974
+ operationId: responses_create
975
+ security:
976
+ - bearerAuth: []
977
+ parameters:
978
+ - name: collectionId
979
+ in: path
980
+ required: true
981
+ schema:
982
+ type: string
983
+ responses:
984
+ 200:
985
+ description: Success
986
+ content:
987
+ application/json:
988
+ schema:
989
+ $ref: "#/components/schemas/ResponsesResult"
990
+ 400:
991
+ description: Bad request
992
+ 401:
993
+ description: Unauthorized
994
+ 404:
995
+ description: Not found
996
+ requestBody:
997
+ required: true
998
+ content:
999
+ application/json:
1000
+ schema:
1001
+ $ref: "#/components/schemas/ResponsesRequest"
941
1002
  /admin/collection/{collectionId}/assignSN/{codeId}:
942
1003
  post:
943
1004
  tags:
@@ -4132,75 +4193,11 @@ paths:
4132
4193
  application/json:
4133
4194
  schema:
4134
4195
  $ref: "#/components/schemas/TimelineRequest"
4135
- /admin/collection/{collectionId}/orders/batch/{batchId}:
4136
- get:
4137
- tags:
4138
- - order
4139
- summary: Find all orders containing items from a specific batch.
4140
- operationId: order_findByBatch
4141
- security:
4142
- - bearerAuth: []
4143
- parameters:
4144
- - name: collectionId
4145
- in: path
4146
- required: true
4147
- schema:
4148
- type: string
4149
- - name: batchId
4150
- in: path
4151
- required: true
4152
- schema:
4153
- type: string
4154
- responses:
4155
- 200:
4156
- description: Success
4157
- content:
4158
- application/json:
4159
- schema:
4160
- $ref: "#/components/schemas/FindOrdersByAttributeResponse"
4161
- 400:
4162
- description: Bad request
4163
- 401:
4164
- description: Unauthorized
4165
- 404:
4166
- description: Not found
4167
- /admin/collection/{collectionId}/orders/batch/{batchId}/items:
4168
- get:
4169
- tags:
4170
- - order
4171
- summary: Get individual order items (not full orders) for a specific batch.
4172
- operationId: order_findItemsByBatch
4173
- security:
4174
- - bearerAuth: []
4175
- parameters:
4176
- - name: collectionId
4177
- in: path
4178
- required: true
4179
- schema:
4180
- type: string
4181
- - name: batchId
4182
- in: path
4183
- required: true
4184
- schema:
4185
- type: string
4186
- responses:
4187
- 200:
4188
- description: Success
4189
- content:
4190
- application/json:
4191
- schema:
4192
- $ref: "#/components/schemas/FindItemsByAttributeResponse"
4193
- 400:
4194
- description: Bad request
4195
- 401:
4196
- description: Unauthorized
4197
- 404:
4198
- description: Not found
4199
4196
  /admin/collection/{collectionId}/orders/ids/{attribute}/{value}:
4200
4197
  get:
4201
4198
  tags:
4202
4199
  - order
4203
- summary: order.getOrderIdsByAttribute
4200
+ summary: Get unique order IDs containing items for a specific product.
4204
4201
  operationId: order_getOrderIdsByAttribute
4205
4202
  security:
4206
4203
  - bearerAuth: []
@@ -4390,70 +4387,6 @@ paths:
4390
4387
  description: Unauthorized
4391
4388
  404:
4392
4389
  description: Not found
4393
- /admin/collection/{collectionId}/orders/variant/{variantId}:
4394
- get:
4395
- tags:
4396
- - order
4397
- summary: Find all orders containing items from a specific variant.
4398
- operationId: order_findByVariant
4399
- security:
4400
- - bearerAuth: []
4401
- parameters:
4402
- - name: collectionId
4403
- in: path
4404
- required: true
4405
- schema:
4406
- type: string
4407
- - name: variantId
4408
- in: path
4409
- required: true
4410
- schema:
4411
- type: string
4412
- responses:
4413
- 200:
4414
- description: Success
4415
- content:
4416
- application/json:
4417
- schema:
4418
- $ref: "#/components/schemas/FindOrdersByAttributeResponse"
4419
- 400:
4420
- description: Bad request
4421
- 401:
4422
- description: Unauthorized
4423
- 404:
4424
- description: Not found
4425
- /admin/collection/{collectionId}/orders/variant/{variantId}/items:
4426
- get:
4427
- tags:
4428
- - order
4429
- summary: Get individual order items for a specific variant.
4430
- operationId: order_findItemsByVariant
4431
- security:
4432
- - bearerAuth: []
4433
- parameters:
4434
- - name: collectionId
4435
- in: path
4436
- required: true
4437
- schema:
4438
- type: string
4439
- - name: variantId
4440
- in: path
4441
- required: true
4442
- schema:
4443
- type: string
4444
- responses:
4445
- 200:
4446
- description: Success
4447
- content:
4448
- application/json:
4449
- schema:
4450
- $ref: "#/components/schemas/FindItemsByAttributeResponse"
4451
- 400:
4452
- description: Bad request
4453
- 401:
4454
- description: Unauthorized
4455
- 404:
4456
- description: Not found
4457
4390
  /admin/collection/{collectionId}/orders/{orderId}:
4458
4391
  get:
4459
4392
  tags:
@@ -6999,9 +6932,9 @@ paths:
6999
6932
  /public/collection/{collectionId}/ai/chat:
7000
6933
  post:
7001
6934
  tags:
7002
- - publicApi
6935
+ - publicClient
7003
6936
  summary: "Generate text-to-speech audio / export async function generate( collectionId: string, request: TTSRequest ): Promise<Blo"
7004
- operationId: publicApi_chat
6937
+ operationId: publicClient_chat
7005
6938
  security: []
7006
6939
  parameters:
7007
6940
  - name: collectionId
@@ -7031,9 +6964,9 @@ paths:
7031
6964
  /public/collection/{collectionId}/ai/rate-limit/{userId}:
7032
6965
  get:
7033
6966
  tags:
7034
- - publicApi
6967
+ - publicClient
7035
6968
  summary: "Get session history / export async function getSession(collectionId: string, sessionId: string): Promise<Session> { cons"
7036
- operationId: publicApi_getRateLimit
6969
+ operationId: publicClient_getRateLimit
7037
6970
  security: []
7038
6971
  parameters:
7039
6972
  - name: collectionId
@@ -7062,9 +6995,9 @@ paths:
7062
6995
  /public/collection/{collectionId}/ai/session/{sessionId}:
7063
6996
  get:
7064
6997
  tags:
7065
- - publicApi
6998
+ - publicClient
7066
6999
  summary: "Chat with product assistant (RAG) / export async function chat( collectionId: string, request: PublicChatRequest ): Prom"
7067
- operationId: publicApi_getSession
7000
+ operationId: publicClient_getSession
7068
7001
  security: []
7069
7002
  parameters:
7070
7003
  - name: collectionId
@@ -7093,9 +7026,9 @@ paths:
7093
7026
  /public/collection/{collectionId}/ai/token:
7094
7027
  post:
7095
7028
  tags:
7096
- - publicApi
7029
+ - publicClient
7097
7030
  summary: "Clear session history / export async function clearSession(collectionId: string, sessionId: string): Promise<{ success:"
7098
- operationId: publicApi_getToken
7031
+ operationId: publicClient_getToken
7099
7032
  security: []
7100
7033
  parameters:
7101
7034
  - name: collectionId
@@ -9828,8 +9761,9 @@ components:
9828
9761
  id:
9829
9762
  type: string
9830
9763
  type:
9831
- type: object
9832
- additionalProperties: true
9764
+ type: string
9765
+ enum:
9766
+ - function
9833
9767
  function:
9834
9768
  type: object
9835
9769
  additionalProperties: true
@@ -9907,6 +9841,177 @@ components:
9907
9841
  - type
9908
9842
  - properties
9909
9843
  - type
9844
+ ResponseTool:
9845
+ type: object
9846
+ properties:
9847
+ type:
9848
+ type: string
9849
+ name:
9850
+ type: string
9851
+ description:
9852
+ type: string
9853
+ parameters:
9854
+ type: object
9855
+ additionalProperties: true
9856
+ required:
9857
+ - type
9858
+ ResponseInputItem:
9859
+ type: object
9860
+ properties:
9861
+ role:
9862
+ type: string
9863
+ enum:
9864
+ - system
9865
+ - user
9866
+ - assistant
9867
+ - function
9868
+ - tool
9869
+ type:
9870
+ type: string
9871
+ content:
9872
+ type: array
9873
+ items:
9874
+ type: object
9875
+ additionalProperties: true
9876
+ name:
9877
+ type: string
9878
+ function_call:
9879
+ $ref: "#/components/schemas/FunctionCall"
9880
+ tool_calls:
9881
+ type: array
9882
+ items:
9883
+ $ref: "#/components/schemas/ToolCall"
9884
+ tool_call_id:
9885
+ type: string
9886
+ ResponsesRequest:
9887
+ type: object
9888
+ properties:
9889
+ model:
9890
+ type: string
9891
+ input:
9892
+ type: array
9893
+ items:
9894
+ type: object
9895
+ additionalProperties: true
9896
+ messages:
9897
+ type: array
9898
+ items:
9899
+ $ref: "#/components/schemas/ResponseInputItem"
9900
+ previous_response_id:
9901
+ type: string
9902
+ conversation:
9903
+ type: object
9904
+ additionalProperties: true
9905
+ tools:
9906
+ type: array
9907
+ items:
9908
+ oneOf:
9909
+ - $ref: "#/components/schemas/ToolDefinition"
9910
+ - $ref: "#/components/schemas/ResponseTool"
9911
+ stream:
9912
+ type: boolean
9913
+ temperature:
9914
+ type: number
9915
+ max_output_tokens:
9916
+ type: number
9917
+ store:
9918
+ type: boolean
9919
+ instructions:
9920
+ type: string
9921
+ include:
9922
+ type: array
9923
+ items:
9924
+ type: string
9925
+ reasoning:
9926
+ type: object
9927
+ additionalProperties: true
9928
+ parallel_tool_calls:
9929
+ type: boolean
9930
+ truncation:
9931
+ type: string
9932
+ enum:
9933
+ - auto
9934
+ - disabled
9935
+ text:
9936
+ type: object
9937
+ additionalProperties: true
9938
+ metadata:
9939
+ type: object
9940
+ additionalProperties:
9941
+ type: string
9942
+ prompt_cache_key:
9943
+ type: string
9944
+ ResponsesResult:
9945
+ type: object
9946
+ properties:
9947
+ id:
9948
+ type: string
9949
+ object:
9950
+ type: string
9951
+ enum:
9952
+ - response
9953
+ created:
9954
+ type: number
9955
+ model:
9956
+ type: string
9957
+ status:
9958
+ type: string
9959
+ enum:
9960
+ - completed
9961
+ - failed
9962
+ - in_progress
9963
+ - queued
9964
+ - cancelled
9965
+ - incomplete
9966
+ output:
9967
+ type: array
9968
+ items: {}
9969
+ output_text:
9970
+ type: string
9971
+ usage:
9972
+ type: object
9973
+ additionalProperties: true
9974
+ input_tokens:
9975
+ type: number
9976
+ output_tokens:
9977
+ type: number
9978
+ total_tokens:
9979
+ type: number
9980
+ error: {}
9981
+ incomplete_details:
9982
+ type: string
9983
+ enum:
9984
+ - max_output_tokens
9985
+ - content_filter
9986
+ previous_response_id:
9987
+ type: string
9988
+ conversation: {}
9989
+ provider:
9990
+ type: string
9991
+ enum:
9992
+ - openai
9993
+ responseTime:
9994
+ type: number
9995
+ required:
9996
+ - id
9997
+ - object
9998
+ - created
9999
+ - model
10000
+ - output
10001
+ - output_text
10002
+ - usage
10003
+ - input_tokens
10004
+ - output_tokens
10005
+ - total_tokens
10006
+ - provider
10007
+ - responseTime
10008
+ ResponsesStreamEvent:
10009
+ type: object
10010
+ properties:
10011
+ type:
10012
+ type: string
10013
+ required:
10014
+ - type
9910
10015
  ChatCompletionRequest:
9911
10016
  type: object
9912
10017
  properties:
@@ -9973,8 +10078,9 @@ components:
9973
10078
  id:
9974
10079
  type: string
9975
10080
  object:
9976
- type: object
9977
- additionalProperties: true
10081
+ type: string
10082
+ enum:
10083
+ - chat.completion
9978
10084
  created:
9979
10085
  type: number
9980
10086
  model:
@@ -10008,8 +10114,9 @@ components:
10008
10114
  id:
10009
10115
  type: string
10010
10116
  object:
10011
- type: object
10012
- additionalProperties: true
10117
+ type: string
10118
+ enum:
10119
+ - chat.completion.chunk
10013
10120
  created:
10014
10121
  type: number
10015
10122
  model:
@@ -10086,6 +10193,35 @@ components:
10086
10193
  - input
10087
10194
  - output
10088
10195
  - features
10196
+ AIModelListParams:
10197
+ type: object
10198
+ properties:
10199
+ provider:
10200
+ type: string
10201
+ enum:
10202
+ - gemini
10203
+ - openai
10204
+ capability:
10205
+ type: string
10206
+ enum:
10207
+ - text
10208
+ - vision
10209
+ - audio
10210
+ - code
10211
+ AIModelListResponse:
10212
+ type: object
10213
+ properties:
10214
+ object:
10215
+ type: string
10216
+ enum:
10217
+ - list
10218
+ data:
10219
+ type: array
10220
+ items:
10221
+ $ref: "#/components/schemas/AIModel"
10222
+ required:
10223
+ - object
10224
+ - data
10089
10225
  DocumentChunk:
10090
10226
  type: object
10091
10227
  properties:
@@ -12040,8 +12176,9 @@ components:
12040
12176
  items:
12041
12177
  $ref: "#/components/schemas/AttestationSummaryBucket"
12042
12178
  audience:
12043
- type: object
12044
- additionalProperties: true
12179
+ type: string
12180
+ enum:
12181
+ - public
12045
12182
  required:
12046
12183
  - summary
12047
12184
  - audience
@@ -12086,8 +12223,9 @@ components:
12086
12223
  items:
12087
12224
  $ref: "#/components/schemas/AttestationSummaryBucket"
12088
12225
  audience:
12089
- type: object
12090
- additionalProperties: true
12226
+ type: string
12227
+ enum:
12228
+ - public
12091
12229
  subjectCount:
12092
12230
  type: number
12093
12231
  required:
@@ -12114,8 +12252,9 @@ components:
12114
12252
  items:
12115
12253
  $ref: "#/components/schemas/LatestAttestation"
12116
12254
  audience:
12117
- type: object
12118
- additionalProperties: true
12255
+ type: string
12256
+ enum:
12257
+ - public
12119
12258
  subjectCount:
12120
12259
  type: number
12121
12260
  required:
@@ -13952,8 +14091,9 @@ components:
13952
14091
  type: object
13953
14092
  additionalProperties: true
13954
14093
  type:
13955
- type: object
13956
- additionalProperties: true
14094
+ type: string
14095
+ enum:
14096
+ - object
13957
14097
  required:
13958
14098
  type: array
13959
14099
  items:
@@ -14425,8 +14565,9 @@ components:
14425
14565
  type: object
14426
14566
  properties:
14427
14567
  type:
14428
- type: object
14429
- additionalProperties: true
14568
+ type: string
14569
+ enum:
14570
+ - smartlinks-route-change
14430
14571
  path:
14431
14572
  type: string
14432
14573
  context:
@@ -14531,8 +14672,9 @@ components:
14531
14672
  type: object
14532
14673
  additionalProperties: true
14533
14674
  phase:
14534
- type: object
14535
- additionalProperties: true
14675
+ type: string
14676
+ enum:
14677
+ - start
14536
14678
  id:
14537
14679
  type: string
14538
14680
  fields:
@@ -14563,8 +14705,9 @@ components:
14563
14705
  type: object
14564
14706
  additionalProperties: true
14565
14707
  phase:
14566
- type: object
14567
- additionalProperties: true
14708
+ type: string
14709
+ enum:
14710
+ - chunk
14568
14711
  id:
14569
14712
  type: string
14570
14713
  seq:
@@ -14584,8 +14727,9 @@ components:
14584
14727
  type: object
14585
14728
  additionalProperties: true
14586
14729
  phase:
14587
- type: object
14588
- additionalProperties: true
14730
+ type: string
14731
+ enum:
14732
+ - end
14589
14733
  id:
14590
14734
  type: string
14591
14735
  required:
@@ -14599,8 +14743,9 @@ components:
14599
14743
  type: object
14600
14744
  additionalProperties: true
14601
14745
  phase:
14602
- type: object
14603
- additionalProperties: true
14746
+ type: string
14747
+ enum:
14748
+ - ack
14604
14749
  id:
14605
14750
  type: string
14606
14751
  seq:
@@ -14617,8 +14762,9 @@ components:
14617
14762
  type: object
14618
14763
  additionalProperties: true
14619
14764
  phase:
14620
- type: object
14621
- additionalProperties: true
14765
+ type: string
14766
+ enum:
14767
+ - done
14622
14768
  id:
14623
14769
  type: string
14624
14770
  ok:
@@ -14673,8 +14819,9 @@ components:
14673
14819
  include:
14674
14820
  type: array
14675
14821
  items:
14676
- type: object
14677
- additionalProperties: true
14822
+ type: string
14823
+ enum:
14824
+ - interaction
14678
14825
  AdminInteractionsCountsByOutcomeRequest:
14679
14826
  type: object
14680
14827
  properties:
@@ -15734,12 +15881,20 @@ components:
15734
15881
  - items
15735
15882
  - limit
15736
15883
  - offset
15737
- QueryOrdersRequest:
15884
+ QueryOrderItemFilter:
15885
+ type: object
15886
+ properties:
15887
+ productId:
15888
+ type: string
15889
+ batchId:
15890
+ type: string
15891
+ variantId:
15892
+ type: string
15893
+ required:
15894
+ - productId
15895
+ QueryOrdersFilter:
15738
15896
  type: object
15739
15897
  properties:
15740
- query:
15741
- type: object
15742
- additionalProperties: true
15743
15898
  status:
15744
15899
  type: string
15745
15900
  orderRef:
@@ -15761,6 +15916,8 @@ components:
15761
15916
  metadata:
15762
15917
  type: object
15763
15918
  additionalProperties: true
15919
+ item:
15920
+ $ref: "#/components/schemas/QueryOrderItemFilter"
15764
15921
  sortBy:
15765
15922
  type: string
15766
15923
  sortOrder:
@@ -15768,6 +15925,11 @@ components:
15768
15925
  enum:
15769
15926
  - asc
15770
15927
  - desc
15928
+ QueryOrdersRequest:
15929
+ type: object
15930
+ properties:
15931
+ query:
15932
+ $ref: "#/components/schemas/QueryOrdersFilter"
15771
15933
  limit:
15772
15934
  type: number
15773
15935
  offset:
@@ -15955,9 +16117,7 @@ components:
15955
16117
  attribute:
15956
16118
  type: string
15957
16119
  enum:
15958
- - batchId
15959
16120
  - productId
15960
- - variantId
15961
16121
  value:
15962
16122
  type: string
15963
16123
  required:
@@ -16970,8 +17130,9 @@ components:
16970
17130
  type: object
16971
17131
  properties:
16972
17132
  engine:
16973
- type: object
16974
- additionalProperties: true
17133
+ type: string
17134
+ enum:
17135
+ - liquid
16975
17136
  source:
16976
17137
  type: string
16977
17138
  props: