@smartytalent/openai-tools 0.8.0 → 0.8.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/tools.json +521 -29
- package/package.json +1 -1
package/dist/tools.json
CHANGED
|
@@ -3633,6 +3633,14 @@
|
|
|
3633
3633
|
"meta": {
|
|
3634
3634
|
"type": "object",
|
|
3635
3635
|
"additionalProperties": true
|
|
3636
|
+
},
|
|
3637
|
+
"consentCurrent": {
|
|
3638
|
+
"type": "boolean",
|
|
3639
|
+
"description": "Write-only, honoured on PATCH. Consent to process for the current recruitment. Merges into `consent.current`, which is what reads return."
|
|
3640
|
+
},
|
|
3641
|
+
"consentFuture": {
|
|
3642
|
+
"type": "boolean",
|
|
3643
|
+
"description": "Write-only, honoured on PATCH. Consent to be kept for future recruitments (TalentPool). The TalentPool search hard-gates on it, so changing this flag re-indexes the talent - set it false to honour a withdrawal."
|
|
3636
3644
|
}
|
|
3637
3645
|
}
|
|
3638
3646
|
},
|
|
@@ -4250,6 +4258,14 @@
|
|
|
4250
4258
|
"meta": {
|
|
4251
4259
|
"type": "object",
|
|
4252
4260
|
"additionalProperties": true
|
|
4261
|
+
},
|
|
4262
|
+
"consentCurrent": {
|
|
4263
|
+
"type": "boolean",
|
|
4264
|
+
"description": "Write-only, honoured on PATCH. Consent to process for the current recruitment. Merges into `consent.current`, which is what reads return."
|
|
4265
|
+
},
|
|
4266
|
+
"consentFuture": {
|
|
4267
|
+
"type": "boolean",
|
|
4268
|
+
"description": "Write-only, honoured on PATCH. Consent to be kept for future recruitments (TalentPool). The TalentPool search hard-gates on it, so changing this flag re-indexes the talent - set it false to honour a withdrawal."
|
|
4253
4269
|
}
|
|
4254
4270
|
}
|
|
4255
4271
|
}
|
|
@@ -9284,14 +9300,18 @@
|
|
|
9284
9300
|
"type": "string",
|
|
9285
9301
|
"description": "Returns surveys with the current status.",
|
|
9286
9302
|
"enum": [
|
|
9287
|
-
"
|
|
9288
|
-
"
|
|
9289
|
-
"
|
|
9303
|
+
"draft",
|
|
9304
|
+
"active",
|
|
9305
|
+
"archived"
|
|
9290
9306
|
]
|
|
9291
9307
|
},
|
|
9292
|
-
"
|
|
9308
|
+
"filterKind": {
|
|
9293
9309
|
"type": "string",
|
|
9294
|
-
"description": "
|
|
9310
|
+
"description": "Returns surveys of one kind.",
|
|
9311
|
+
"enum": [
|
|
9312
|
+
"cnps",
|
|
9313
|
+
"general"
|
|
9314
|
+
]
|
|
9295
9315
|
},
|
|
9296
9316
|
"filterCreatedFrom": {
|
|
9297
9317
|
"type": "string",
|
|
@@ -9329,6 +9349,174 @@
|
|
|
9329
9349
|
}
|
|
9330
9350
|
}
|
|
9331
9351
|
},
|
|
9352
|
+
{
|
|
9353
|
+
"type": "function",
|
|
9354
|
+
"function": {
|
|
9355
|
+
"name": "create_survey",
|
|
9356
|
+
"description": "Create Survey",
|
|
9357
|
+
"parameters": {
|
|
9358
|
+
"title": "CreateSurveyRequestBody",
|
|
9359
|
+
"type": "object",
|
|
9360
|
+
"required": [
|
|
9361
|
+
"data"
|
|
9362
|
+
],
|
|
9363
|
+
"properties": {
|
|
9364
|
+
"data": {
|
|
9365
|
+
"title": "CreateSurveyRequestBodyData",
|
|
9366
|
+
"type": "object",
|
|
9367
|
+
"required": [
|
|
9368
|
+
"type",
|
|
9369
|
+
"attributes"
|
|
9370
|
+
],
|
|
9371
|
+
"properties": {
|
|
9372
|
+
"type": {
|
|
9373
|
+
"type": "string",
|
|
9374
|
+
"enum": [
|
|
9375
|
+
"surveys"
|
|
9376
|
+
]
|
|
9377
|
+
},
|
|
9378
|
+
"attributes": {
|
|
9379
|
+
"title": "CreateSurveyRequestBodyDataAttributes",
|
|
9380
|
+
"type": "object",
|
|
9381
|
+
"required": [
|
|
9382
|
+
"name"
|
|
9383
|
+
],
|
|
9384
|
+
"properties": {
|
|
9385
|
+
"name": {
|
|
9386
|
+
"type": "string",
|
|
9387
|
+
"minLength": 5,
|
|
9388
|
+
"maxLength": 255
|
|
9389
|
+
},
|
|
9390
|
+
"kind": {
|
|
9391
|
+
"type": "string",
|
|
9392
|
+
"enum": [
|
|
9393
|
+
"cnps",
|
|
9394
|
+
"general"
|
|
9395
|
+
]
|
|
9396
|
+
},
|
|
9397
|
+
"content": {
|
|
9398
|
+
"title": "SurveyContentSchema",
|
|
9399
|
+
"type": "object",
|
|
9400
|
+
"description": "The questionnaire: a locale-keyed title plus an ordered question list.",
|
|
9401
|
+
"properties": {
|
|
9402
|
+
"title": {
|
|
9403
|
+
"type": "object",
|
|
9404
|
+
"additionalProperties": {
|
|
9405
|
+
"type": "string"
|
|
9406
|
+
},
|
|
9407
|
+
"description": "Locale map, e.g. {\"en-US\": \"Your application experience\", \"pl-PL\": \"...\"}. en-US is required to publish; clients render by locale prefix with en-US fallback."
|
|
9408
|
+
},
|
|
9409
|
+
"questions": {
|
|
9410
|
+
"type": "array",
|
|
9411
|
+
"minItems": 1,
|
|
9412
|
+
"maxItems": 50,
|
|
9413
|
+
"items": {
|
|
9414
|
+
"title": "SurveyQuestionSchema",
|
|
9415
|
+
"type": "object",
|
|
9416
|
+
"description": "One question. Common fields: questionId (server-assigned when\nomitted; stable forever after - answers key on it), type, text\n(locale map), required. Per-type fields:\n scale - scaleMin/scaleMax (integers, min < max),\n optional scaleLabels {min, max} locale maps,\n optional subtype \"nps\" (pins 0-10, enables\n detractor/passive/promoter classification)\n single-choice / multiple-choice\n - options: 2-20 entries of {value, label};\n value is a stable lowercase slug (a-z, 0-9, -)\n the recipient submits; label is a locale map\n open-text - maxLength (default 2000, max 5000)",
|
|
9417
|
+
"properties": {
|
|
9418
|
+
"questionId": {
|
|
9419
|
+
"type": "string",
|
|
9420
|
+
"maxLength": 64,
|
|
9421
|
+
"description": "Stable identity of the question. Server-assigned uuid hex when omitted at save."
|
|
9422
|
+
},
|
|
9423
|
+
"type": {
|
|
9424
|
+
"type": "string",
|
|
9425
|
+
"enum": [
|
|
9426
|
+
"scale",
|
|
9427
|
+
"single-choice",
|
|
9428
|
+
"multiple-choice",
|
|
9429
|
+
"open-text"
|
|
9430
|
+
]
|
|
9431
|
+
},
|
|
9432
|
+
"subtype": {
|
|
9433
|
+
"type": "string",
|
|
9434
|
+
"enum": [
|
|
9435
|
+
"nps"
|
|
9436
|
+
],
|
|
9437
|
+
"description": "scale only. nps pins scaleMin=0/scaleMax=10 and classifies answers detractor/passive/promoter on submit."
|
|
9438
|
+
},
|
|
9439
|
+
"required": {
|
|
9440
|
+
"type": "boolean",
|
|
9441
|
+
"default": false
|
|
9442
|
+
},
|
|
9443
|
+
"text": {
|
|
9444
|
+
"type": "object",
|
|
9445
|
+
"additionalProperties": {
|
|
9446
|
+
"type": "string"
|
|
9447
|
+
},
|
|
9448
|
+
"description": "Locale map of the question text. en-US required to publish."
|
|
9449
|
+
},
|
|
9450
|
+
"scaleMin": {
|
|
9451
|
+
"type": "integer",
|
|
9452
|
+
"minimum": 0,
|
|
9453
|
+
"maximum": 100
|
|
9454
|
+
},
|
|
9455
|
+
"scaleMax": {
|
|
9456
|
+
"type": "integer",
|
|
9457
|
+
"minimum": 0,
|
|
9458
|
+
"maximum": 100
|
|
9459
|
+
},
|
|
9460
|
+
"scaleLabels": {
|
|
9461
|
+
"type": "object",
|
|
9462
|
+
"description": "Optional locale maps for the scale endpoints.",
|
|
9463
|
+
"properties": {
|
|
9464
|
+
"min": {
|
|
9465
|
+
"type": "object",
|
|
9466
|
+
"additionalProperties": {
|
|
9467
|
+
"type": "string"
|
|
9468
|
+
}
|
|
9469
|
+
},
|
|
9470
|
+
"max": {
|
|
9471
|
+
"type": "object",
|
|
9472
|
+
"additionalProperties": {
|
|
9473
|
+
"type": "string"
|
|
9474
|
+
}
|
|
9475
|
+
}
|
|
9476
|
+
}
|
|
9477
|
+
},
|
|
9478
|
+
"options": {
|
|
9479
|
+
"type": "array",
|
|
9480
|
+
"minItems": 2,
|
|
9481
|
+
"maxItems": 20,
|
|
9482
|
+
"items": {
|
|
9483
|
+
"title": "SurveyQuestionOptionSchema",
|
|
9484
|
+
"type": "object",
|
|
9485
|
+
"properties": {
|
|
9486
|
+
"value": {
|
|
9487
|
+
"type": "string",
|
|
9488
|
+
"maxLength": 64,
|
|
9489
|
+
"description": "Stable lowercase slug (a-z, 0-9, -). What the recipient submits - locale-proof, never the label."
|
|
9490
|
+
},
|
|
9491
|
+
"label": {
|
|
9492
|
+
"type": "object",
|
|
9493
|
+
"additionalProperties": {
|
|
9494
|
+
"type": "string"
|
|
9495
|
+
},
|
|
9496
|
+
"description": "Locale map. en-US required to publish."
|
|
9497
|
+
}
|
|
9498
|
+
}
|
|
9499
|
+
}
|
|
9500
|
+
},
|
|
9501
|
+
"maxLength": {
|
|
9502
|
+
"type": "integer",
|
|
9503
|
+
"minimum": 1,
|
|
9504
|
+
"maximum": 5000,
|
|
9505
|
+
"description": "open-text only. Default 2000."
|
|
9506
|
+
}
|
|
9507
|
+
}
|
|
9508
|
+
}
|
|
9509
|
+
}
|
|
9510
|
+
}
|
|
9511
|
+
}
|
|
9512
|
+
}
|
|
9513
|
+
}
|
|
9514
|
+
}
|
|
9515
|
+
}
|
|
9516
|
+
}
|
|
9517
|
+
}
|
|
9518
|
+
}
|
|
9519
|
+
},
|
|
9332
9520
|
{
|
|
9333
9521
|
"type": "function",
|
|
9334
9522
|
"function": {
|
|
@@ -9359,6 +9547,215 @@
|
|
|
9359
9547
|
}
|
|
9360
9548
|
}
|
|
9361
9549
|
},
|
|
9550
|
+
{
|
|
9551
|
+
"type": "function",
|
|
9552
|
+
"function": {
|
|
9553
|
+
"name": "update_survey",
|
|
9554
|
+
"description": "Update Survey",
|
|
9555
|
+
"parameters": {
|
|
9556
|
+
"type": "object",
|
|
9557
|
+
"properties": {
|
|
9558
|
+
"surveyId": {
|
|
9559
|
+
"type": "string",
|
|
9560
|
+
"description": "surveyId parameter"
|
|
9561
|
+
},
|
|
9562
|
+
"requestBody": {
|
|
9563
|
+
"title": "UpdateSurveyRequestBody",
|
|
9564
|
+
"type": "object",
|
|
9565
|
+
"required": [
|
|
9566
|
+
"data"
|
|
9567
|
+
],
|
|
9568
|
+
"properties": {
|
|
9569
|
+
"data": {
|
|
9570
|
+
"title": "UpdateSurveyRequestBodyData",
|
|
9571
|
+
"type": "object",
|
|
9572
|
+
"required": [
|
|
9573
|
+
"type"
|
|
9574
|
+
],
|
|
9575
|
+
"properties": {
|
|
9576
|
+
"type": {
|
|
9577
|
+
"type": "string",
|
|
9578
|
+
"enum": [
|
|
9579
|
+
"surveys"
|
|
9580
|
+
]
|
|
9581
|
+
},
|
|
9582
|
+
"id": {
|
|
9583
|
+
"type": "string"
|
|
9584
|
+
},
|
|
9585
|
+
"attributes": {
|
|
9586
|
+
"title": "UpdateSurveyRequestBodyDataAttributes",
|
|
9587
|
+
"type": "object",
|
|
9588
|
+
"properties": {
|
|
9589
|
+
"name": {
|
|
9590
|
+
"type": "string",
|
|
9591
|
+
"minLength": 5,
|
|
9592
|
+
"maxLength": 255
|
|
9593
|
+
},
|
|
9594
|
+
"status": {
|
|
9595
|
+
"type": "string",
|
|
9596
|
+
"enum": [
|
|
9597
|
+
"draft",
|
|
9598
|
+
"active",
|
|
9599
|
+
"archived"
|
|
9600
|
+
],
|
|
9601
|
+
"description": "active = publish. Allowed transitions: draft->active, draft->archived, active->archived, archived->active; active->active re-publishes the edited draft."
|
|
9602
|
+
},
|
|
9603
|
+
"content": {
|
|
9604
|
+
"title": "SurveyContentSchema",
|
|
9605
|
+
"type": "object",
|
|
9606
|
+
"description": "The questionnaire: a locale-keyed title plus an ordered question list.",
|
|
9607
|
+
"properties": {
|
|
9608
|
+
"title": {
|
|
9609
|
+
"type": "object",
|
|
9610
|
+
"additionalProperties": {
|
|
9611
|
+
"type": "string"
|
|
9612
|
+
},
|
|
9613
|
+
"description": "Locale map, e.g. {\"en-US\": \"Your application experience\", \"pl-PL\": \"...\"}. en-US is required to publish; clients render by locale prefix with en-US fallback."
|
|
9614
|
+
},
|
|
9615
|
+
"questions": {
|
|
9616
|
+
"type": "array",
|
|
9617
|
+
"minItems": 1,
|
|
9618
|
+
"maxItems": 50,
|
|
9619
|
+
"items": {
|
|
9620
|
+
"title": "SurveyQuestionSchema",
|
|
9621
|
+
"type": "object",
|
|
9622
|
+
"description": "One question. Common fields: questionId (server-assigned when\nomitted; stable forever after - answers key on it), type, text\n(locale map), required. Per-type fields:\n scale - scaleMin/scaleMax (integers, min < max),\n optional scaleLabels {min, max} locale maps,\n optional subtype \"nps\" (pins 0-10, enables\n detractor/passive/promoter classification)\n single-choice / multiple-choice\n - options: 2-20 entries of {value, label};\n value is a stable lowercase slug (a-z, 0-9, -)\n the recipient submits; label is a locale map\n open-text - maxLength (default 2000, max 5000)",
|
|
9623
|
+
"properties": {
|
|
9624
|
+
"questionId": {
|
|
9625
|
+
"type": "string",
|
|
9626
|
+
"maxLength": 64,
|
|
9627
|
+
"description": "Stable identity of the question. Server-assigned uuid hex when omitted at save."
|
|
9628
|
+
},
|
|
9629
|
+
"type": {
|
|
9630
|
+
"type": "string",
|
|
9631
|
+
"enum": [
|
|
9632
|
+
"scale",
|
|
9633
|
+
"single-choice",
|
|
9634
|
+
"multiple-choice",
|
|
9635
|
+
"open-text"
|
|
9636
|
+
]
|
|
9637
|
+
},
|
|
9638
|
+
"subtype": {
|
|
9639
|
+
"type": "string",
|
|
9640
|
+
"enum": [
|
|
9641
|
+
"nps"
|
|
9642
|
+
],
|
|
9643
|
+
"description": "scale only. nps pins scaleMin=0/scaleMax=10 and classifies answers detractor/passive/promoter on submit."
|
|
9644
|
+
},
|
|
9645
|
+
"required": {
|
|
9646
|
+
"type": "boolean",
|
|
9647
|
+
"default": false
|
|
9648
|
+
},
|
|
9649
|
+
"text": {
|
|
9650
|
+
"type": "object",
|
|
9651
|
+
"additionalProperties": {
|
|
9652
|
+
"type": "string"
|
|
9653
|
+
},
|
|
9654
|
+
"description": "Locale map of the question text. en-US required to publish."
|
|
9655
|
+
},
|
|
9656
|
+
"scaleMin": {
|
|
9657
|
+
"type": "integer",
|
|
9658
|
+
"minimum": 0,
|
|
9659
|
+
"maximum": 100
|
|
9660
|
+
},
|
|
9661
|
+
"scaleMax": {
|
|
9662
|
+
"type": "integer",
|
|
9663
|
+
"minimum": 0,
|
|
9664
|
+
"maximum": 100
|
|
9665
|
+
},
|
|
9666
|
+
"scaleLabels": {
|
|
9667
|
+
"type": "object",
|
|
9668
|
+
"description": "Optional locale maps for the scale endpoints.",
|
|
9669
|
+
"properties": {
|
|
9670
|
+
"min": {
|
|
9671
|
+
"type": "object",
|
|
9672
|
+
"additionalProperties": {
|
|
9673
|
+
"type": "string"
|
|
9674
|
+
}
|
|
9675
|
+
},
|
|
9676
|
+
"max": {
|
|
9677
|
+
"type": "object",
|
|
9678
|
+
"additionalProperties": {
|
|
9679
|
+
"type": "string"
|
|
9680
|
+
}
|
|
9681
|
+
}
|
|
9682
|
+
}
|
|
9683
|
+
},
|
|
9684
|
+
"options": {
|
|
9685
|
+
"type": "array",
|
|
9686
|
+
"minItems": 2,
|
|
9687
|
+
"maxItems": 20,
|
|
9688
|
+
"items": {
|
|
9689
|
+
"title": "SurveyQuestionOptionSchema",
|
|
9690
|
+
"type": "object",
|
|
9691
|
+
"properties": {
|
|
9692
|
+
"value": {
|
|
9693
|
+
"type": "string",
|
|
9694
|
+
"maxLength": 64,
|
|
9695
|
+
"description": "Stable lowercase slug (a-z, 0-9, -). What the recipient submits - locale-proof, never the label."
|
|
9696
|
+
},
|
|
9697
|
+
"label": {
|
|
9698
|
+
"type": "object",
|
|
9699
|
+
"additionalProperties": {
|
|
9700
|
+
"type": "string"
|
|
9701
|
+
},
|
|
9702
|
+
"description": "Locale map. en-US required to publish."
|
|
9703
|
+
}
|
|
9704
|
+
}
|
|
9705
|
+
}
|
|
9706
|
+
},
|
|
9707
|
+
"maxLength": {
|
|
9708
|
+
"type": "integer",
|
|
9709
|
+
"minimum": 1,
|
|
9710
|
+
"maximum": 5000,
|
|
9711
|
+
"description": "open-text only. Default 2000."
|
|
9712
|
+
}
|
|
9713
|
+
}
|
|
9714
|
+
}
|
|
9715
|
+
}
|
|
9716
|
+
}
|
|
9717
|
+
}
|
|
9718
|
+
}
|
|
9719
|
+
}
|
|
9720
|
+
}
|
|
9721
|
+
}
|
|
9722
|
+
}
|
|
9723
|
+
}
|
|
9724
|
+
},
|
|
9725
|
+
"required": [
|
|
9726
|
+
"surveyId",
|
|
9727
|
+
"requestBody"
|
|
9728
|
+
]
|
|
9729
|
+
}
|
|
9730
|
+
}
|
|
9731
|
+
},
|
|
9732
|
+
{
|
|
9733
|
+
"type": "function",
|
|
9734
|
+
"function": {
|
|
9735
|
+
"name": "delete_survey",
|
|
9736
|
+
"description": "Delete Survey",
|
|
9737
|
+
"parameters": {
|
|
9738
|
+
"type": "object",
|
|
9739
|
+
"properties": {
|
|
9740
|
+
"surveyId": {
|
|
9741
|
+
"type": "string",
|
|
9742
|
+
"description": "surveyId parameter"
|
|
9743
|
+
},
|
|
9744
|
+
"permanentDelete": {
|
|
9745
|
+
"type": "string",
|
|
9746
|
+
"description": "true removes the row instead of archiving it.",
|
|
9747
|
+
"enum": [
|
|
9748
|
+
"true",
|
|
9749
|
+
"false"
|
|
9750
|
+
]
|
|
9751
|
+
}
|
|
9752
|
+
},
|
|
9753
|
+
"required": [
|
|
9754
|
+
"surveyId"
|
|
9755
|
+
]
|
|
9756
|
+
}
|
|
9757
|
+
}
|
|
9758
|
+
},
|
|
9362
9759
|
{
|
|
9363
9760
|
"type": "function",
|
|
9364
9761
|
"function": {
|
|
@@ -9373,8 +9770,110 @@
|
|
|
9373
9770
|
{
|
|
9374
9771
|
"type": "function",
|
|
9375
9772
|
"function": {
|
|
9376
|
-
"name": "
|
|
9377
|
-
"description": "
|
|
9773
|
+
"name": "list_responses",
|
|
9774
|
+
"description": "List Responses",
|
|
9775
|
+
"parameters": {
|
|
9776
|
+
"type": "object",
|
|
9777
|
+
"properties": {
|
|
9778
|
+
"filterStatus": {
|
|
9779
|
+
"type": "string",
|
|
9780
|
+
"description": "Returns responses with the current status.",
|
|
9781
|
+
"enum": [
|
|
9782
|
+
"pending",
|
|
9783
|
+
"completed",
|
|
9784
|
+
"expired"
|
|
9785
|
+
]
|
|
9786
|
+
},
|
|
9787
|
+
"filterSurveyId": {
|
|
9788
|
+
"type": "string",
|
|
9789
|
+
"description": "Filter by the survey definition the response belongs to."
|
|
9790
|
+
},
|
|
9791
|
+
"filterCandidateId": {
|
|
9792
|
+
"type": "string",
|
|
9793
|
+
"description": "Filter by the candidate the invitation was sent to."
|
|
9794
|
+
},
|
|
9795
|
+
"filterCreatedFrom": {
|
|
9796
|
+
"type": "string",
|
|
9797
|
+
"description": "Filters results to include only those created from the specified date and time. The value must be in ISO 8601 format."
|
|
9798
|
+
},
|
|
9799
|
+
"filterCreatedTo": {
|
|
9800
|
+
"type": "string",
|
|
9801
|
+
"description": "Filters results to include only those created up to the specified date and time. The value must be in ISO 8601 format."
|
|
9802
|
+
},
|
|
9803
|
+
"filterModifiedFrom": {
|
|
9804
|
+
"type": "string",
|
|
9805
|
+
"description": "Filters results to include only those modified from the specified date and time. The value must be in ISO 8601 format."
|
|
9806
|
+
},
|
|
9807
|
+
"filterModifiedTo": {
|
|
9808
|
+
"type": "string",
|
|
9809
|
+
"description": "Filters results to include only those modified up to the specified date and time. The value must be in ISO 8601 format."
|
|
9810
|
+
},
|
|
9811
|
+
"pageSize": {
|
|
9812
|
+
"type": "integer",
|
|
9813
|
+
"description": "Specifies the number of items to retrieve per page. The maximum value is 100."
|
|
9814
|
+
},
|
|
9815
|
+
"pageNumber": {
|
|
9816
|
+
"type": "integer",
|
|
9817
|
+
"description": "Specifies the page number to retrieve. Used for traditional pagination."
|
|
9818
|
+
},
|
|
9819
|
+
"pageAfter": {
|
|
9820
|
+
"type": "string",
|
|
9821
|
+
"description": "Opaque base64-encoded cursor returned by a previous list response, used for forward cursor-based pagination. Pass the value verbatim; do not decode or mutate it."
|
|
9822
|
+
},
|
|
9823
|
+
"pageBefore": {
|
|
9824
|
+
"type": "string",
|
|
9825
|
+
"description": "Returns the data encoded in Base64 format, used for cursor-based pagination"
|
|
9826
|
+
}
|
|
9827
|
+
}
|
|
9828
|
+
}
|
|
9829
|
+
}
|
|
9830
|
+
},
|
|
9831
|
+
{
|
|
9832
|
+
"type": "function",
|
|
9833
|
+
"function": {
|
|
9834
|
+
"name": "responses_options",
|
|
9835
|
+
"description": "Responses Options",
|
|
9836
|
+
"parameters": {
|
|
9837
|
+
"type": "object",
|
|
9838
|
+
"properties": {}
|
|
9839
|
+
}
|
|
9840
|
+
}
|
|
9841
|
+
},
|
|
9842
|
+
{
|
|
9843
|
+
"type": "function",
|
|
9844
|
+
"function": {
|
|
9845
|
+
"name": "show_response",
|
|
9846
|
+
"description": "Show Response",
|
|
9847
|
+
"parameters": {
|
|
9848
|
+
"type": "object",
|
|
9849
|
+
"properties": {
|
|
9850
|
+
"responseId": {
|
|
9851
|
+
"type": "string",
|
|
9852
|
+
"description": "responseId parameter"
|
|
9853
|
+
}
|
|
9854
|
+
},
|
|
9855
|
+
"required": [
|
|
9856
|
+
"responseId"
|
|
9857
|
+
]
|
|
9858
|
+
}
|
|
9859
|
+
}
|
|
9860
|
+
},
|
|
9861
|
+
{
|
|
9862
|
+
"type": "function",
|
|
9863
|
+
"function": {
|
|
9864
|
+
"name": "response_options",
|
|
9865
|
+
"description": "Response Options",
|
|
9866
|
+
"parameters": {
|
|
9867
|
+
"type": "object",
|
|
9868
|
+
"properties": {}
|
|
9869
|
+
}
|
|
9870
|
+
}
|
|
9871
|
+
},
|
|
9872
|
+
{
|
|
9873
|
+
"type": "function",
|
|
9874
|
+
"function": {
|
|
9875
|
+
"name": "show_guest_response",
|
|
9876
|
+
"description": "Show Guest Response",
|
|
9378
9877
|
"parameters": {
|
|
9379
9878
|
"type": "object",
|
|
9380
9879
|
"properties": {
|
|
@@ -9384,7 +9883,7 @@
|
|
|
9384
9883
|
},
|
|
9385
9884
|
"token": {
|
|
9386
9885
|
"type": "string",
|
|
9387
|
-
"description": "Per-
|
|
9886
|
+
"description": "Per-response accessToken from the emailed link. Compared with hmac.compare_digest; mismatch returns 404."
|
|
9388
9887
|
}
|
|
9389
9888
|
},
|
|
9390
9889
|
"required": [
|
|
@@ -9397,10 +9896,10 @@
|
|
|
9397
9896
|
{
|
|
9398
9897
|
"type": "function",
|
|
9399
9898
|
"function": {
|
|
9400
|
-
"name": "
|
|
9401
|
-
"description": "Submit Guest
|
|
9899
|
+
"name": "submit_guest_response",
|
|
9900
|
+
"description": "Submit Guest Response",
|
|
9402
9901
|
"parameters": {
|
|
9403
|
-
"title": "
|
|
9902
|
+
"title": "SubmitGuestResponseRequestBody",
|
|
9404
9903
|
"type": "object",
|
|
9405
9904
|
"required": [
|
|
9406
9905
|
"data",
|
|
@@ -9408,7 +9907,7 @@
|
|
|
9408
9907
|
],
|
|
9409
9908
|
"properties": {
|
|
9410
9909
|
"data": {
|
|
9411
|
-
"title": "
|
|
9910
|
+
"title": "SubmitGuestResponseRequestBodyData",
|
|
9412
9911
|
"type": "object",
|
|
9413
9912
|
"required": [
|
|
9414
9913
|
"type",
|
|
@@ -9418,37 +9917,30 @@
|
|
|
9418
9917
|
"type": {
|
|
9419
9918
|
"type": "string",
|
|
9420
9919
|
"enum": [
|
|
9421
|
-
"
|
|
9920
|
+
"responses"
|
|
9422
9921
|
]
|
|
9423
9922
|
},
|
|
9424
9923
|
"id": {
|
|
9425
9924
|
"type": "string"
|
|
9426
9925
|
},
|
|
9427
9926
|
"attributes": {
|
|
9428
|
-
"title": "
|
|
9927
|
+
"title": "SubmitGuestResponseRequestBodyDataAttributes",
|
|
9429
9928
|
"type": "object",
|
|
9430
9929
|
"required": [
|
|
9431
|
-
"
|
|
9930
|
+
"answers"
|
|
9432
9931
|
],
|
|
9433
9932
|
"properties": {
|
|
9434
|
-
"
|
|
9435
|
-
"type": "
|
|
9436
|
-
"
|
|
9437
|
-
"maximum": 10,
|
|
9438
|
-
"description": "The NPS answer. 0-6 buckets to detractor, 7-8 passive, 9-10 promoter - the bucketing happens server-side."
|
|
9439
|
-
},
|
|
9440
|
-
"comment": {
|
|
9441
|
-
"type": "string",
|
|
9442
|
-
"maxLength": 2000,
|
|
9443
|
-
"description": "Optional free text. Trimmed server-side; an empty string is stored as absent."
|
|
9933
|
+
"answers": {
|
|
9934
|
+
"type": "object",
|
|
9935
|
+
"description": "Keyed by questionId. Scale values are classified server-side (0-6 detractor, 7-8 passive, 9-10 promoter for nps questions)."
|
|
9444
9936
|
}
|
|
9445
9937
|
}
|
|
9446
9938
|
}
|
|
9447
9939
|
}
|
|
9448
9940
|
},
|
|
9449
9941
|
"meta": {
|
|
9450
|
-
"title": "
|
|
9451
|
-
"description": "Auth context for the unauthenticated PATCH
|
|
9942
|
+
"title": "GuestResponseMetaSchema",
|
|
9943
|
+
"description": "Auth context for the unauthenticated PATCH\n/v1/guest/responses/{id}. Both values come from the emailed link,\nnever from a session - there is no authorizer on the guest path.\ntenantId is the BASE tenant id; accessToken is the per-response\ntoken minted at create and compared with hmac.compare_digest. Any\nmismatch returns 404, intentionally indistinguishable from\n\"response not found\" so existence is never leaked.",
|
|
9452
9944
|
"type": "object",
|
|
9453
9945
|
"required": [
|
|
9454
9946
|
"tenantId",
|
|
@@ -9470,8 +9962,8 @@
|
|
|
9470
9962
|
{
|
|
9471
9963
|
"type": "function",
|
|
9472
9964
|
"function": {
|
|
9473
|
-
"name": "
|
|
9474
|
-
"description": "Guest
|
|
9965
|
+
"name": "guest_response_options",
|
|
9966
|
+
"description": "Guest Response Options",
|
|
9475
9967
|
"parameters": {
|
|
9476
9968
|
"type": "object",
|
|
9477
9969
|
"properties": {}
|