@shuffl/api-contracts 0.5.1 → 0.5.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/index.d.ts +90 -3
- package/dist/management-operations.d.ts +1 -1
- package/dist/management-operations.js +9 -1
- package/dist/management.generated.d.ts +88 -3
- package/dist/management.generated.js +95 -1
- package/dist/permissions.d.ts +2 -0
- package/openapi.json +1116 -287
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -35413,6 +35413,9 @@
|
|
|
35413
35413
|
{
|
|
35414
35414
|
"const": "groups.setAutomationState"
|
|
35415
35415
|
},
|
|
35416
|
+
{
|
|
35417
|
+
"const": "groups.setPlaybookAutoStart"
|
|
35418
|
+
},
|
|
35416
35419
|
{
|
|
35417
35420
|
"const": "groups.suggestions"
|
|
35418
35421
|
},
|
|
@@ -37144,6 +37147,9 @@
|
|
|
37144
37147
|
{
|
|
37145
37148
|
"const": "groups.setAutomationState"
|
|
37146
37149
|
},
|
|
37150
|
+
{
|
|
37151
|
+
"const": "groups.setPlaybookAutoStart"
|
|
37152
|
+
},
|
|
37147
37153
|
{
|
|
37148
37154
|
"const": "groups.suggestions"
|
|
37149
37155
|
},
|
|
@@ -38450,6 +38456,9 @@
|
|
|
38450
38456
|
{
|
|
38451
38457
|
"const": "groups.setAutomationState"
|
|
38452
38458
|
},
|
|
38459
|
+
{
|
|
38460
|
+
"const": "groups.setPlaybookAutoStart"
|
|
38461
|
+
},
|
|
38453
38462
|
{
|
|
38454
38463
|
"const": "groups.suggestions"
|
|
38455
38464
|
},
|
|
@@ -48774,6 +48783,16 @@
|
|
|
48774
48783
|
}
|
|
48775
48784
|
]
|
|
48776
48785
|
},
|
|
48786
|
+
"autoStartPaused": {
|
|
48787
|
+
"anyOf": [
|
|
48788
|
+
{
|
|
48789
|
+
"const": false
|
|
48790
|
+
},
|
|
48791
|
+
{
|
|
48792
|
+
"const": true
|
|
48793
|
+
}
|
|
48794
|
+
]
|
|
48795
|
+
},
|
|
48777
48796
|
"buddy": {
|
|
48778
48797
|
"anyOf": [
|
|
48779
48798
|
{
|
|
@@ -54202,7 +54221,7 @@
|
|
|
54202
54221
|
"/manage/groups/allAutomations": {
|
|
54203
54222
|
"post": {
|
|
54204
54223
|
"operationId": "groups.allAutomations",
|
|
54205
|
-
"summary": "Every
|
|
54224
|
+
"summary": "Every join and leave rule in the workspace: group automations with their group and last runs, playbooks that start on each start date and Connections programs whose people are a group; or only those that start one playbook, program or community",
|
|
54206
54225
|
"requestBody": {
|
|
54207
54226
|
"required": true,
|
|
54208
54227
|
"content": {
|
|
@@ -54456,6 +54475,189 @@
|
|
|
54456
54475
|
"additionalProperties": false
|
|
54457
54476
|
}
|
|
54458
54477
|
},
|
|
54478
|
+
"playbookStarts": {
|
|
54479
|
+
"type": "array",
|
|
54480
|
+
"items": {
|
|
54481
|
+
"type": "object",
|
|
54482
|
+
"properties": {
|
|
54483
|
+
"group": {
|
|
54484
|
+
"anyOf": [
|
|
54485
|
+
{
|
|
54486
|
+
"type": "null"
|
|
54487
|
+
},
|
|
54488
|
+
{
|
|
54489
|
+
"type": "object",
|
|
54490
|
+
"properties": {
|
|
54491
|
+
"id": {
|
|
54492
|
+
"type": "string"
|
|
54493
|
+
},
|
|
54494
|
+
"kind": {
|
|
54495
|
+
"anyOf": [
|
|
54496
|
+
{
|
|
54497
|
+
"const": "dynamic"
|
|
54498
|
+
},
|
|
54499
|
+
{
|
|
54500
|
+
"const": "list"
|
|
54501
|
+
}
|
|
54502
|
+
]
|
|
54503
|
+
},
|
|
54504
|
+
"members": {
|
|
54505
|
+
"type": "number"
|
|
54506
|
+
},
|
|
54507
|
+
"name": {
|
|
54508
|
+
"type": "string"
|
|
54509
|
+
}
|
|
54510
|
+
},
|
|
54511
|
+
"required": [
|
|
54512
|
+
"id",
|
|
54513
|
+
"kind",
|
|
54514
|
+
"members",
|
|
54515
|
+
"name"
|
|
54516
|
+
],
|
|
54517
|
+
"additionalProperties": false
|
|
54518
|
+
}
|
|
54519
|
+
]
|
|
54520
|
+
},
|
|
54521
|
+
"lastRunAt": {
|
|
54522
|
+
"anyOf": [
|
|
54523
|
+
{
|
|
54524
|
+
"type": "null"
|
|
54525
|
+
},
|
|
54526
|
+
{
|
|
54527
|
+
"type": "string",
|
|
54528
|
+
"format": "date-time"
|
|
54529
|
+
}
|
|
54530
|
+
]
|
|
54531
|
+
},
|
|
54532
|
+
"playbook": {
|
|
54533
|
+
"type": "object",
|
|
54534
|
+
"properties": {
|
|
54535
|
+
"id": {
|
|
54536
|
+
"type": "string"
|
|
54537
|
+
},
|
|
54538
|
+
"name": {
|
|
54539
|
+
"type": "string"
|
|
54540
|
+
},
|
|
54541
|
+
"status": {
|
|
54542
|
+
"anyOf": [
|
|
54543
|
+
{
|
|
54544
|
+
"const": "active"
|
|
54545
|
+
},
|
|
54546
|
+
{
|
|
54547
|
+
"const": "archived"
|
|
54548
|
+
},
|
|
54549
|
+
{
|
|
54550
|
+
"const": "paused"
|
|
54551
|
+
}
|
|
54552
|
+
]
|
|
54553
|
+
}
|
|
54554
|
+
},
|
|
54555
|
+
"required": [
|
|
54556
|
+
"id",
|
|
54557
|
+
"name",
|
|
54558
|
+
"status"
|
|
54559
|
+
],
|
|
54560
|
+
"additionalProperties": false
|
|
54561
|
+
},
|
|
54562
|
+
"runs": {
|
|
54563
|
+
"type": "number"
|
|
54564
|
+
},
|
|
54565
|
+
"runs30": {
|
|
54566
|
+
"type": "number"
|
|
54567
|
+
},
|
|
54568
|
+
"state": {
|
|
54569
|
+
"anyOf": [
|
|
54570
|
+
{
|
|
54571
|
+
"const": "active"
|
|
54572
|
+
},
|
|
54573
|
+
{
|
|
54574
|
+
"const": "paused"
|
|
54575
|
+
}
|
|
54576
|
+
]
|
|
54577
|
+
}
|
|
54578
|
+
},
|
|
54579
|
+
"required": [
|
|
54580
|
+
"group",
|
|
54581
|
+
"lastRunAt",
|
|
54582
|
+
"playbook",
|
|
54583
|
+
"runs",
|
|
54584
|
+
"runs30",
|
|
54585
|
+
"state"
|
|
54586
|
+
],
|
|
54587
|
+
"additionalProperties": false
|
|
54588
|
+
}
|
|
54589
|
+
},
|
|
54590
|
+
"programRosters": {
|
|
54591
|
+
"type": "array",
|
|
54592
|
+
"items": {
|
|
54593
|
+
"type": "object",
|
|
54594
|
+
"properties": {
|
|
54595
|
+
"group": {
|
|
54596
|
+
"type": "object",
|
|
54597
|
+
"properties": {
|
|
54598
|
+
"id": {
|
|
54599
|
+
"type": "string"
|
|
54600
|
+
},
|
|
54601
|
+
"kind": {
|
|
54602
|
+
"anyOf": [
|
|
54603
|
+
{
|
|
54604
|
+
"const": "dynamic"
|
|
54605
|
+
},
|
|
54606
|
+
{
|
|
54607
|
+
"const": "list"
|
|
54608
|
+
}
|
|
54609
|
+
]
|
|
54610
|
+
},
|
|
54611
|
+
"members": {
|
|
54612
|
+
"type": "number"
|
|
54613
|
+
},
|
|
54614
|
+
"name": {
|
|
54615
|
+
"type": "string"
|
|
54616
|
+
}
|
|
54617
|
+
},
|
|
54618
|
+
"required": [
|
|
54619
|
+
"id",
|
|
54620
|
+
"kind",
|
|
54621
|
+
"members",
|
|
54622
|
+
"name"
|
|
54623
|
+
],
|
|
54624
|
+
"additionalProperties": false
|
|
54625
|
+
},
|
|
54626
|
+
"program": {
|
|
54627
|
+
"type": "object",
|
|
54628
|
+
"properties": {
|
|
54629
|
+
"id": {
|
|
54630
|
+
"type": "string"
|
|
54631
|
+
},
|
|
54632
|
+
"name": {
|
|
54633
|
+
"type": "string"
|
|
54634
|
+
}
|
|
54635
|
+
},
|
|
54636
|
+
"required": [
|
|
54637
|
+
"id",
|
|
54638
|
+
"name"
|
|
54639
|
+
],
|
|
54640
|
+
"additionalProperties": false
|
|
54641
|
+
},
|
|
54642
|
+
"state": {
|
|
54643
|
+
"anyOf": [
|
|
54644
|
+
{
|
|
54645
|
+
"const": "active"
|
|
54646
|
+
},
|
|
54647
|
+
{
|
|
54648
|
+
"const": "paused"
|
|
54649
|
+
}
|
|
54650
|
+
]
|
|
54651
|
+
}
|
|
54652
|
+
},
|
|
54653
|
+
"required": [
|
|
54654
|
+
"group",
|
|
54655
|
+
"program",
|
|
54656
|
+
"state"
|
|
54657
|
+
],
|
|
54658
|
+
"additionalProperties": false
|
|
54659
|
+
}
|
|
54660
|
+
},
|
|
54459
54661
|
"runs": {
|
|
54460
54662
|
"type": "array",
|
|
54461
54663
|
"items": {
|
|
@@ -54618,6 +54820,8 @@
|
|
|
54618
54820
|
},
|
|
54619
54821
|
"required": [
|
|
54620
54822
|
"automations",
|
|
54823
|
+
"playbookStarts",
|
|
54824
|
+
"programRosters",
|
|
54621
54825
|
"runs",
|
|
54622
54826
|
"totals"
|
|
54623
54827
|
],
|
|
@@ -67742,13 +67946,844 @@
|
|
|
67742
67946
|
}
|
|
67743
67947
|
},
|
|
67744
67948
|
"x-shuffl-access": "write",
|
|
67745
|
-
"x-shuffl-permission": "groups.sendMessage"
|
|
67949
|
+
"x-shuffl-permission": "groups.sendMessage"
|
|
67950
|
+
}
|
|
67951
|
+
},
|
|
67952
|
+
"/manage/groups/setAutomation": {
|
|
67953
|
+
"post": {
|
|
67954
|
+
"operationId": "groups.setAutomation",
|
|
67955
|
+
"summary": "Add or change an automation on a group; a new one starts paused",
|
|
67956
|
+
"requestBody": {
|
|
67957
|
+
"required": true,
|
|
67958
|
+
"content": {
|
|
67959
|
+
"application/json": {
|
|
67960
|
+
"schema": {
|
|
67961
|
+
"type": "object",
|
|
67962
|
+
"properties": {
|
|
67963
|
+
"config": {
|
|
67964
|
+
"anyOf": [
|
|
67965
|
+
{
|
|
67966
|
+
"type": "null"
|
|
67967
|
+
},
|
|
67968
|
+
{
|
|
67969
|
+
"type": "object",
|
|
67970
|
+
"properties": {
|
|
67971
|
+
"action": {
|
|
67972
|
+
"anyOf": [
|
|
67973
|
+
{
|
|
67974
|
+
"type": "null"
|
|
67975
|
+
},
|
|
67976
|
+
{
|
|
67977
|
+
"type": "object",
|
|
67978
|
+
"properties": {
|
|
67979
|
+
"label": {
|
|
67980
|
+
"type": "string"
|
|
67981
|
+
},
|
|
67982
|
+
"path": {
|
|
67983
|
+
"type": "string"
|
|
67984
|
+
}
|
|
67985
|
+
},
|
|
67986
|
+
"required": [
|
|
67987
|
+
"label",
|
|
67988
|
+
"path"
|
|
67989
|
+
],
|
|
67990
|
+
"additionalProperties": false
|
|
67991
|
+
}
|
|
67992
|
+
]
|
|
67993
|
+
},
|
|
67994
|
+
"body": {
|
|
67995
|
+
"type": "array",
|
|
67996
|
+
"items": {
|
|
67997
|
+
"type": "string"
|
|
67998
|
+
}
|
|
67999
|
+
},
|
|
68000
|
+
"channel": {
|
|
68001
|
+
"anyOf": [
|
|
68002
|
+
{
|
|
68003
|
+
"const": "email"
|
|
68004
|
+
},
|
|
68005
|
+
{
|
|
68006
|
+
"const": "preferred"
|
|
68007
|
+
},
|
|
68008
|
+
{
|
|
68009
|
+
"const": "slack"
|
|
68010
|
+
}
|
|
68011
|
+
]
|
|
68012
|
+
},
|
|
68013
|
+
"communityId": {
|
|
68014
|
+
"type": "string"
|
|
68015
|
+
},
|
|
68016
|
+
"note": {
|
|
68017
|
+
"type": "string"
|
|
68018
|
+
},
|
|
68019
|
+
"programId": {
|
|
68020
|
+
"type": "string"
|
|
68021
|
+
},
|
|
68022
|
+
"subject": {
|
|
68023
|
+
"type": "string"
|
|
68024
|
+
}
|
|
68025
|
+
},
|
|
68026
|
+
"additionalProperties": false
|
|
68027
|
+
}
|
|
68028
|
+
]
|
|
68029
|
+
},
|
|
68030
|
+
"groupId": {
|
|
68031
|
+
"type": "string"
|
|
68032
|
+
},
|
|
68033
|
+
"id": {
|
|
68034
|
+
"type": "string"
|
|
68035
|
+
},
|
|
68036
|
+
"kind": {
|
|
68037
|
+
"anyOf": [
|
|
68038
|
+
{
|
|
68039
|
+
"const": "add_to_program"
|
|
68040
|
+
},
|
|
68041
|
+
{
|
|
68042
|
+
"const": "invite_community"
|
|
68043
|
+
},
|
|
68044
|
+
{
|
|
68045
|
+
"const": "send_message"
|
|
68046
|
+
},
|
|
68047
|
+
{
|
|
68048
|
+
"const": "start_playbook"
|
|
68049
|
+
},
|
|
68050
|
+
{
|
|
68051
|
+
"const": "tell_hr"
|
|
68052
|
+
},
|
|
68053
|
+
{
|
|
68054
|
+
"const": "tell_manager"
|
|
68055
|
+
}
|
|
68056
|
+
]
|
|
68057
|
+
},
|
|
68058
|
+
"trigger": {
|
|
68059
|
+
"anyOf": [
|
|
68060
|
+
{
|
|
68061
|
+
"const": "entered"
|
|
68062
|
+
},
|
|
68063
|
+
{
|
|
68064
|
+
"const": "left"
|
|
68065
|
+
}
|
|
68066
|
+
]
|
|
68067
|
+
},
|
|
68068
|
+
"confirm": {
|
|
68069
|
+
"const": "groups.setAutomation"
|
|
68070
|
+
},
|
|
68071
|
+
"requestKey": {
|
|
68072
|
+
"type": "string",
|
|
68073
|
+
"minLength": 1,
|
|
68074
|
+
"maxLength": 128
|
|
68075
|
+
}
|
|
68076
|
+
},
|
|
68077
|
+
"required": [
|
|
68078
|
+
"groupId",
|
|
68079
|
+
"kind",
|
|
68080
|
+
"trigger",
|
|
68081
|
+
"confirm",
|
|
68082
|
+
"requestKey"
|
|
68083
|
+
],
|
|
68084
|
+
"additionalProperties": false
|
|
68085
|
+
}
|
|
68086
|
+
}
|
|
68087
|
+
}
|
|
68088
|
+
},
|
|
68089
|
+
"responses": {
|
|
68090
|
+
"200": {
|
|
68091
|
+
"description": "OK",
|
|
68092
|
+
"content": {
|
|
68093
|
+
"application/json": {
|
|
68094
|
+
"schema": {
|
|
68095
|
+
"type": "object",
|
|
68096
|
+
"properties": {
|
|
68097
|
+
"receipt": {
|
|
68098
|
+
"type": "object",
|
|
68099
|
+
"properties": {
|
|
68100
|
+
"completedAt": {
|
|
68101
|
+
"anyOf": [
|
|
68102
|
+
{
|
|
68103
|
+
"type": "string",
|
|
68104
|
+
"format": "date-time"
|
|
68105
|
+
},
|
|
68106
|
+
{
|
|
68107
|
+
"type": "null"
|
|
68108
|
+
}
|
|
68109
|
+
]
|
|
68110
|
+
},
|
|
68111
|
+
"createdAt": {
|
|
68112
|
+
"type": "string",
|
|
68113
|
+
"format": "date-time"
|
|
68114
|
+
},
|
|
68115
|
+
"id": {
|
|
68116
|
+
"type": "string",
|
|
68117
|
+
"format": "uuid"
|
|
68118
|
+
},
|
|
68119
|
+
"operation": {
|
|
68120
|
+
"type": "string"
|
|
68121
|
+
},
|
|
68122
|
+
"requestKey": {
|
|
68123
|
+
"type": "string"
|
|
68124
|
+
},
|
|
68125
|
+
"status": {
|
|
68126
|
+
"enum": [
|
|
68127
|
+
"running",
|
|
68128
|
+
"succeeded",
|
|
68129
|
+
"failed",
|
|
68130
|
+
"unknown"
|
|
68131
|
+
],
|
|
68132
|
+
"type": "string"
|
|
68133
|
+
}
|
|
68134
|
+
},
|
|
68135
|
+
"required": [
|
|
68136
|
+
"completedAt",
|
|
68137
|
+
"createdAt",
|
|
68138
|
+
"id",
|
|
68139
|
+
"operation",
|
|
68140
|
+
"requestKey",
|
|
68141
|
+
"status"
|
|
68142
|
+
]
|
|
68143
|
+
},
|
|
68144
|
+
"result": {
|
|
68145
|
+
"anyOf": [
|
|
68146
|
+
{
|
|
68147
|
+
"type": "object",
|
|
68148
|
+
"properties": {
|
|
68149
|
+
"action": {
|
|
68150
|
+
"type": "string"
|
|
68151
|
+
},
|
|
68152
|
+
"config": {
|
|
68153
|
+
"type": "object",
|
|
68154
|
+
"properties": {
|
|
68155
|
+
"action": {
|
|
68156
|
+
"anyOf": [
|
|
68157
|
+
{
|
|
68158
|
+
"type": "null"
|
|
68159
|
+
},
|
|
68160
|
+
{
|
|
68161
|
+
"type": "object",
|
|
68162
|
+
"properties": {
|
|
68163
|
+
"label": {
|
|
68164
|
+
"type": "string"
|
|
68165
|
+
},
|
|
68166
|
+
"path": {
|
|
68167
|
+
"type": "string"
|
|
68168
|
+
}
|
|
68169
|
+
},
|
|
68170
|
+
"required": [
|
|
68171
|
+
"label",
|
|
68172
|
+
"path"
|
|
68173
|
+
],
|
|
68174
|
+
"additionalProperties": false
|
|
68175
|
+
}
|
|
68176
|
+
]
|
|
68177
|
+
},
|
|
68178
|
+
"body": {
|
|
68179
|
+
"type": "array",
|
|
68180
|
+
"items": {
|
|
68181
|
+
"type": "string"
|
|
68182
|
+
}
|
|
68183
|
+
},
|
|
68184
|
+
"channel": {
|
|
68185
|
+
"anyOf": [
|
|
68186
|
+
{
|
|
68187
|
+
"const": "email"
|
|
68188
|
+
},
|
|
68189
|
+
{
|
|
68190
|
+
"const": "preferred"
|
|
68191
|
+
},
|
|
68192
|
+
{
|
|
68193
|
+
"const": "slack"
|
|
68194
|
+
}
|
|
68195
|
+
]
|
|
68196
|
+
},
|
|
68197
|
+
"communityId": {
|
|
68198
|
+
"type": "string"
|
|
68199
|
+
},
|
|
68200
|
+
"note": {
|
|
68201
|
+
"type": "string"
|
|
68202
|
+
},
|
|
68203
|
+
"programId": {
|
|
68204
|
+
"type": "string"
|
|
68205
|
+
},
|
|
68206
|
+
"subject": {
|
|
68207
|
+
"type": "string"
|
|
68208
|
+
}
|
|
68209
|
+
},
|
|
68210
|
+
"additionalProperties": false
|
|
68211
|
+
},
|
|
68212
|
+
"createdAt": {
|
|
68213
|
+
"type": "string",
|
|
68214
|
+
"format": "date-time"
|
|
68215
|
+
},
|
|
68216
|
+
"createdBy": {
|
|
68217
|
+
"anyOf": [
|
|
68218
|
+
{
|
|
68219
|
+
"type": "null"
|
|
68220
|
+
},
|
|
68221
|
+
{
|
|
68222
|
+
"type": "string"
|
|
68223
|
+
}
|
|
68224
|
+
]
|
|
68225
|
+
},
|
|
68226
|
+
"groupId": {
|
|
68227
|
+
"type": "string"
|
|
68228
|
+
},
|
|
68229
|
+
"id": {
|
|
68230
|
+
"type": "string"
|
|
68231
|
+
},
|
|
68232
|
+
"kind": {
|
|
68233
|
+
"anyOf": [
|
|
68234
|
+
{
|
|
68235
|
+
"const": "add_to_program"
|
|
68236
|
+
},
|
|
68237
|
+
{
|
|
68238
|
+
"const": "invite_community"
|
|
68239
|
+
},
|
|
68240
|
+
{
|
|
68241
|
+
"const": "send_message"
|
|
68242
|
+
},
|
|
68243
|
+
{
|
|
68244
|
+
"const": "start_playbook"
|
|
68245
|
+
},
|
|
68246
|
+
{
|
|
68247
|
+
"const": "tell_hr"
|
|
68248
|
+
},
|
|
68249
|
+
{
|
|
68250
|
+
"const": "tell_manager"
|
|
68251
|
+
}
|
|
68252
|
+
]
|
|
68253
|
+
},
|
|
68254
|
+
"lastRunAt": {
|
|
68255
|
+
"anyOf": [
|
|
68256
|
+
{
|
|
68257
|
+
"type": "null"
|
|
68258
|
+
},
|
|
68259
|
+
{
|
|
68260
|
+
"type": "string",
|
|
68261
|
+
"format": "date-time"
|
|
68262
|
+
}
|
|
68263
|
+
]
|
|
68264
|
+
},
|
|
68265
|
+
"runs": {
|
|
68266
|
+
"type": "number"
|
|
68267
|
+
},
|
|
68268
|
+
"state": {
|
|
68269
|
+
"anyOf": [
|
|
68270
|
+
{
|
|
68271
|
+
"const": "active"
|
|
68272
|
+
},
|
|
68273
|
+
{
|
|
68274
|
+
"const": "paused"
|
|
68275
|
+
}
|
|
68276
|
+
]
|
|
68277
|
+
},
|
|
68278
|
+
"summary": {
|
|
68279
|
+
"type": "string"
|
|
68280
|
+
},
|
|
68281
|
+
"target": {
|
|
68282
|
+
"anyOf": [
|
|
68283
|
+
{
|
|
68284
|
+
"type": "null"
|
|
68285
|
+
},
|
|
68286
|
+
{
|
|
68287
|
+
"type": "object",
|
|
68288
|
+
"properties": {
|
|
68289
|
+
"id": {
|
|
68290
|
+
"type": "string"
|
|
68291
|
+
},
|
|
68292
|
+
"name": {
|
|
68293
|
+
"anyOf": [
|
|
68294
|
+
{
|
|
68295
|
+
"type": "null"
|
|
68296
|
+
},
|
|
68297
|
+
{
|
|
68298
|
+
"type": "string"
|
|
68299
|
+
}
|
|
68300
|
+
]
|
|
68301
|
+
}
|
|
68302
|
+
},
|
|
68303
|
+
"required": [
|
|
68304
|
+
"id",
|
|
68305
|
+
"name"
|
|
68306
|
+
],
|
|
68307
|
+
"additionalProperties": false
|
|
68308
|
+
}
|
|
68309
|
+
]
|
|
68310
|
+
},
|
|
68311
|
+
"trigger": {
|
|
68312
|
+
"anyOf": [
|
|
68313
|
+
{
|
|
68314
|
+
"const": "entered"
|
|
68315
|
+
},
|
|
68316
|
+
{
|
|
68317
|
+
"const": "left"
|
|
68318
|
+
}
|
|
68319
|
+
]
|
|
68320
|
+
},
|
|
68321
|
+
"updatedAt": {
|
|
68322
|
+
"type": "string",
|
|
68323
|
+
"format": "date-time"
|
|
68324
|
+
}
|
|
68325
|
+
},
|
|
68326
|
+
"required": [
|
|
68327
|
+
"action",
|
|
68328
|
+
"config",
|
|
68329
|
+
"createdAt",
|
|
68330
|
+
"createdBy",
|
|
68331
|
+
"groupId",
|
|
68332
|
+
"id",
|
|
68333
|
+
"kind",
|
|
68334
|
+
"lastRunAt",
|
|
68335
|
+
"runs",
|
|
68336
|
+
"state",
|
|
68337
|
+
"summary",
|
|
68338
|
+
"target",
|
|
68339
|
+
"trigger",
|
|
68340
|
+
"updatedAt"
|
|
68341
|
+
],
|
|
68342
|
+
"additionalProperties": false
|
|
68343
|
+
},
|
|
68344
|
+
{
|
|
68345
|
+
"type": "null"
|
|
68346
|
+
}
|
|
68347
|
+
]
|
|
68348
|
+
}
|
|
68349
|
+
},
|
|
68350
|
+
"required": [
|
|
68351
|
+
"receipt",
|
|
68352
|
+
"result"
|
|
68353
|
+
]
|
|
68354
|
+
}
|
|
68355
|
+
}
|
|
68356
|
+
}
|
|
68357
|
+
},
|
|
68358
|
+
"400": {
|
|
68359
|
+
"description": "400",
|
|
68360
|
+
"content": {
|
|
68361
|
+
"application/json": {
|
|
68362
|
+
"schema": {
|
|
68363
|
+
"oneOf": [
|
|
68364
|
+
{
|
|
68365
|
+
"type": "object",
|
|
68366
|
+
"properties": {
|
|
68367
|
+
"defined": {
|
|
68368
|
+
"const": true
|
|
68369
|
+
},
|
|
68370
|
+
"code": {
|
|
68371
|
+
"const": "BAD_REQUEST"
|
|
68372
|
+
},
|
|
68373
|
+
"status": {
|
|
68374
|
+
"const": 400
|
|
68375
|
+
},
|
|
68376
|
+
"message": {
|
|
68377
|
+
"type": "string",
|
|
68378
|
+
"default": "Check the request input."
|
|
68379
|
+
},
|
|
68380
|
+
"data": {}
|
|
68381
|
+
},
|
|
68382
|
+
"required": [
|
|
68383
|
+
"defined",
|
|
68384
|
+
"code",
|
|
68385
|
+
"status",
|
|
68386
|
+
"message"
|
|
68387
|
+
]
|
|
68388
|
+
},
|
|
68389
|
+
{
|
|
68390
|
+
"type": "object",
|
|
68391
|
+
"properties": {
|
|
68392
|
+
"defined": {
|
|
68393
|
+
"const": false
|
|
68394
|
+
},
|
|
68395
|
+
"code": {
|
|
68396
|
+
"type": "string"
|
|
68397
|
+
},
|
|
68398
|
+
"status": {
|
|
68399
|
+
"type": "number"
|
|
68400
|
+
},
|
|
68401
|
+
"message": {
|
|
68402
|
+
"type": "string"
|
|
68403
|
+
},
|
|
68404
|
+
"data": {}
|
|
68405
|
+
},
|
|
68406
|
+
"required": [
|
|
68407
|
+
"defined",
|
|
68408
|
+
"code",
|
|
68409
|
+
"status",
|
|
68410
|
+
"message"
|
|
68411
|
+
]
|
|
68412
|
+
}
|
|
68413
|
+
]
|
|
68414
|
+
}
|
|
68415
|
+
}
|
|
68416
|
+
}
|
|
68417
|
+
},
|
|
68418
|
+
"401": {
|
|
68419
|
+
"description": "401",
|
|
68420
|
+
"content": {
|
|
68421
|
+
"application/json": {
|
|
68422
|
+
"schema": {
|
|
68423
|
+
"oneOf": [
|
|
68424
|
+
{
|
|
68425
|
+
"type": "object",
|
|
68426
|
+
"properties": {
|
|
68427
|
+
"defined": {
|
|
68428
|
+
"const": true
|
|
68429
|
+
},
|
|
68430
|
+
"code": {
|
|
68431
|
+
"const": "UNAUTHORIZED"
|
|
68432
|
+
},
|
|
68433
|
+
"status": {
|
|
68434
|
+
"const": 401
|
|
68435
|
+
},
|
|
68436
|
+
"message": {
|
|
68437
|
+
"type": "string",
|
|
68438
|
+
"default": "A valid Shuffl API token is required."
|
|
68439
|
+
},
|
|
68440
|
+
"data": {}
|
|
68441
|
+
},
|
|
68442
|
+
"required": [
|
|
68443
|
+
"defined",
|
|
68444
|
+
"code",
|
|
68445
|
+
"status",
|
|
68446
|
+
"message"
|
|
68447
|
+
]
|
|
68448
|
+
},
|
|
68449
|
+
{
|
|
68450
|
+
"type": "object",
|
|
68451
|
+
"properties": {
|
|
68452
|
+
"defined": {
|
|
68453
|
+
"const": false
|
|
68454
|
+
},
|
|
68455
|
+
"code": {
|
|
68456
|
+
"type": "string"
|
|
68457
|
+
},
|
|
68458
|
+
"status": {
|
|
68459
|
+
"type": "number"
|
|
68460
|
+
},
|
|
68461
|
+
"message": {
|
|
68462
|
+
"type": "string"
|
|
68463
|
+
},
|
|
68464
|
+
"data": {}
|
|
68465
|
+
},
|
|
68466
|
+
"required": [
|
|
68467
|
+
"defined",
|
|
68468
|
+
"code",
|
|
68469
|
+
"status",
|
|
68470
|
+
"message"
|
|
68471
|
+
]
|
|
68472
|
+
}
|
|
68473
|
+
]
|
|
68474
|
+
}
|
|
68475
|
+
}
|
|
68476
|
+
}
|
|
68477
|
+
},
|
|
68478
|
+
"403": {
|
|
68479
|
+
"description": "403",
|
|
68480
|
+
"content": {
|
|
68481
|
+
"application/json": {
|
|
68482
|
+
"schema": {
|
|
68483
|
+
"oneOf": [
|
|
68484
|
+
{
|
|
68485
|
+
"type": "object",
|
|
68486
|
+
"properties": {
|
|
68487
|
+
"defined": {
|
|
68488
|
+
"const": true
|
|
68489
|
+
},
|
|
68490
|
+
"code": {
|
|
68491
|
+
"const": "FORBIDDEN"
|
|
68492
|
+
},
|
|
68493
|
+
"status": {
|
|
68494
|
+
"const": 403
|
|
68495
|
+
},
|
|
68496
|
+
"message": {
|
|
68497
|
+
"type": "string",
|
|
68498
|
+
"default": "This token or team role does not permit the operation."
|
|
68499
|
+
},
|
|
68500
|
+
"data": {}
|
|
68501
|
+
},
|
|
68502
|
+
"required": [
|
|
68503
|
+
"defined",
|
|
68504
|
+
"code",
|
|
68505
|
+
"status",
|
|
68506
|
+
"message"
|
|
68507
|
+
]
|
|
68508
|
+
},
|
|
68509
|
+
{
|
|
68510
|
+
"type": "object",
|
|
68511
|
+
"properties": {
|
|
68512
|
+
"defined": {
|
|
68513
|
+
"const": false
|
|
68514
|
+
},
|
|
68515
|
+
"code": {
|
|
68516
|
+
"type": "string"
|
|
68517
|
+
},
|
|
68518
|
+
"status": {
|
|
68519
|
+
"type": "number"
|
|
68520
|
+
},
|
|
68521
|
+
"message": {
|
|
68522
|
+
"type": "string"
|
|
68523
|
+
},
|
|
68524
|
+
"data": {}
|
|
68525
|
+
},
|
|
68526
|
+
"required": [
|
|
68527
|
+
"defined",
|
|
68528
|
+
"code",
|
|
68529
|
+
"status",
|
|
68530
|
+
"message"
|
|
68531
|
+
]
|
|
68532
|
+
}
|
|
68533
|
+
]
|
|
68534
|
+
}
|
|
68535
|
+
}
|
|
68536
|
+
}
|
|
68537
|
+
},
|
|
68538
|
+
"404": {
|
|
68539
|
+
"description": "404",
|
|
68540
|
+
"content": {
|
|
68541
|
+
"application/json": {
|
|
68542
|
+
"schema": {
|
|
68543
|
+
"oneOf": [
|
|
68544
|
+
{
|
|
68545
|
+
"type": "object",
|
|
68546
|
+
"properties": {
|
|
68547
|
+
"defined": {
|
|
68548
|
+
"const": true
|
|
68549
|
+
},
|
|
68550
|
+
"code": {
|
|
68551
|
+
"const": "NOT_FOUND"
|
|
68552
|
+
},
|
|
68553
|
+
"status": {
|
|
68554
|
+
"const": 404
|
|
68555
|
+
},
|
|
68556
|
+
"message": {
|
|
68557
|
+
"type": "string",
|
|
68558
|
+
"default": "The requested resource was not found."
|
|
68559
|
+
},
|
|
68560
|
+
"data": {}
|
|
68561
|
+
},
|
|
68562
|
+
"required": [
|
|
68563
|
+
"defined",
|
|
68564
|
+
"code",
|
|
68565
|
+
"status",
|
|
68566
|
+
"message"
|
|
68567
|
+
]
|
|
68568
|
+
},
|
|
68569
|
+
{
|
|
68570
|
+
"type": "object",
|
|
68571
|
+
"properties": {
|
|
68572
|
+
"defined": {
|
|
68573
|
+
"const": false
|
|
68574
|
+
},
|
|
68575
|
+
"code": {
|
|
68576
|
+
"type": "string"
|
|
68577
|
+
},
|
|
68578
|
+
"status": {
|
|
68579
|
+
"type": "number"
|
|
68580
|
+
},
|
|
68581
|
+
"message": {
|
|
68582
|
+
"type": "string"
|
|
68583
|
+
},
|
|
68584
|
+
"data": {}
|
|
68585
|
+
},
|
|
68586
|
+
"required": [
|
|
68587
|
+
"defined",
|
|
68588
|
+
"code",
|
|
68589
|
+
"status",
|
|
68590
|
+
"message"
|
|
68591
|
+
]
|
|
68592
|
+
}
|
|
68593
|
+
]
|
|
68594
|
+
}
|
|
68595
|
+
}
|
|
68596
|
+
}
|
|
68597
|
+
},
|
|
68598
|
+
"409": {
|
|
68599
|
+
"description": "409",
|
|
68600
|
+
"content": {
|
|
68601
|
+
"application/json": {
|
|
68602
|
+
"schema": {
|
|
68603
|
+
"oneOf": [
|
|
68604
|
+
{
|
|
68605
|
+
"type": "object",
|
|
68606
|
+
"properties": {
|
|
68607
|
+
"defined": {
|
|
68608
|
+
"const": true
|
|
68609
|
+
},
|
|
68610
|
+
"code": {
|
|
68611
|
+
"const": "CONFLICT"
|
|
68612
|
+
},
|
|
68613
|
+
"status": {
|
|
68614
|
+
"const": 409
|
|
68615
|
+
},
|
|
68616
|
+
"message": {
|
|
68617
|
+
"type": "string",
|
|
68618
|
+
"default": "The resource changed or the request key was reused."
|
|
68619
|
+
},
|
|
68620
|
+
"data": {}
|
|
68621
|
+
},
|
|
68622
|
+
"required": [
|
|
68623
|
+
"defined",
|
|
68624
|
+
"code",
|
|
68625
|
+
"status",
|
|
68626
|
+
"message"
|
|
68627
|
+
]
|
|
68628
|
+
},
|
|
68629
|
+
{
|
|
68630
|
+
"type": "object",
|
|
68631
|
+
"properties": {
|
|
68632
|
+
"defined": {
|
|
68633
|
+
"const": false
|
|
68634
|
+
},
|
|
68635
|
+
"code": {
|
|
68636
|
+
"type": "string"
|
|
68637
|
+
},
|
|
68638
|
+
"status": {
|
|
68639
|
+
"type": "number"
|
|
68640
|
+
},
|
|
68641
|
+
"message": {
|
|
68642
|
+
"type": "string"
|
|
68643
|
+
},
|
|
68644
|
+
"data": {}
|
|
68645
|
+
},
|
|
68646
|
+
"required": [
|
|
68647
|
+
"defined",
|
|
68648
|
+
"code",
|
|
68649
|
+
"status",
|
|
68650
|
+
"message"
|
|
68651
|
+
]
|
|
68652
|
+
}
|
|
68653
|
+
]
|
|
68654
|
+
}
|
|
68655
|
+
}
|
|
68656
|
+
}
|
|
68657
|
+
},
|
|
68658
|
+
"412": {
|
|
68659
|
+
"description": "412",
|
|
68660
|
+
"content": {
|
|
68661
|
+
"application/json": {
|
|
68662
|
+
"schema": {
|
|
68663
|
+
"oneOf": [
|
|
68664
|
+
{
|
|
68665
|
+
"type": "object",
|
|
68666
|
+
"properties": {
|
|
68667
|
+
"defined": {
|
|
68668
|
+
"const": true
|
|
68669
|
+
},
|
|
68670
|
+
"code": {
|
|
68671
|
+
"const": "PRECONDITION_FAILED"
|
|
68672
|
+
},
|
|
68673
|
+
"status": {
|
|
68674
|
+
"const": 412
|
|
68675
|
+
},
|
|
68676
|
+
"message": {
|
|
68677
|
+
"type": "string",
|
|
68678
|
+
"default": "The team is not ready for this operation."
|
|
68679
|
+
},
|
|
68680
|
+
"data": {}
|
|
68681
|
+
},
|
|
68682
|
+
"required": [
|
|
68683
|
+
"defined",
|
|
68684
|
+
"code",
|
|
68685
|
+
"status",
|
|
68686
|
+
"message"
|
|
68687
|
+
]
|
|
68688
|
+
},
|
|
68689
|
+
{
|
|
68690
|
+
"type": "object",
|
|
68691
|
+
"properties": {
|
|
68692
|
+
"defined": {
|
|
68693
|
+
"const": false
|
|
68694
|
+
},
|
|
68695
|
+
"code": {
|
|
68696
|
+
"type": "string"
|
|
68697
|
+
},
|
|
68698
|
+
"status": {
|
|
68699
|
+
"type": "number"
|
|
68700
|
+
},
|
|
68701
|
+
"message": {
|
|
68702
|
+
"type": "string"
|
|
68703
|
+
},
|
|
68704
|
+
"data": {}
|
|
68705
|
+
},
|
|
68706
|
+
"required": [
|
|
68707
|
+
"defined",
|
|
68708
|
+
"code",
|
|
68709
|
+
"status",
|
|
68710
|
+
"message"
|
|
68711
|
+
]
|
|
68712
|
+
}
|
|
68713
|
+
]
|
|
68714
|
+
}
|
|
68715
|
+
}
|
|
68716
|
+
}
|
|
68717
|
+
},
|
|
68718
|
+
"429": {
|
|
68719
|
+
"description": "429",
|
|
68720
|
+
"content": {
|
|
68721
|
+
"application/json": {
|
|
68722
|
+
"schema": {
|
|
68723
|
+
"oneOf": [
|
|
68724
|
+
{
|
|
68725
|
+
"type": "object",
|
|
68726
|
+
"properties": {
|
|
68727
|
+
"defined": {
|
|
68728
|
+
"const": true
|
|
68729
|
+
},
|
|
68730
|
+
"code": {
|
|
68731
|
+
"const": "TOO_MANY_REQUESTS"
|
|
68732
|
+
},
|
|
68733
|
+
"status": {
|
|
68734
|
+
"const": 429
|
|
68735
|
+
},
|
|
68736
|
+
"message": {
|
|
68737
|
+
"type": "string",
|
|
68738
|
+
"default": "Too many requests. Try again shortly."
|
|
68739
|
+
},
|
|
68740
|
+
"data": {}
|
|
68741
|
+
},
|
|
68742
|
+
"required": [
|
|
68743
|
+
"defined",
|
|
68744
|
+
"code",
|
|
68745
|
+
"status",
|
|
68746
|
+
"message"
|
|
68747
|
+
]
|
|
68748
|
+
},
|
|
68749
|
+
{
|
|
68750
|
+
"type": "object",
|
|
68751
|
+
"properties": {
|
|
68752
|
+
"defined": {
|
|
68753
|
+
"const": false
|
|
68754
|
+
},
|
|
68755
|
+
"code": {
|
|
68756
|
+
"type": "string"
|
|
68757
|
+
},
|
|
68758
|
+
"status": {
|
|
68759
|
+
"type": "number"
|
|
68760
|
+
},
|
|
68761
|
+
"message": {
|
|
68762
|
+
"type": "string"
|
|
68763
|
+
},
|
|
68764
|
+
"data": {}
|
|
68765
|
+
},
|
|
68766
|
+
"required": [
|
|
68767
|
+
"defined",
|
|
68768
|
+
"code",
|
|
68769
|
+
"status",
|
|
68770
|
+
"message"
|
|
68771
|
+
]
|
|
68772
|
+
}
|
|
68773
|
+
]
|
|
68774
|
+
}
|
|
68775
|
+
}
|
|
68776
|
+
}
|
|
68777
|
+
}
|
|
68778
|
+
},
|
|
68779
|
+
"x-shuffl-access": "write",
|
|
68780
|
+
"x-shuffl-permission": "groups.setAutomation"
|
|
67746
68781
|
}
|
|
67747
68782
|
},
|
|
67748
|
-
"/manage/groups/
|
|
68783
|
+
"/manage/groups/setAutomationState": {
|
|
67749
68784
|
"post": {
|
|
67750
|
-
"operationId": "groups.
|
|
67751
|
-
"summary": "
|
|
68785
|
+
"operationId": "groups.setAutomationState",
|
|
68786
|
+
"summary": "Pause or resume an automation on a group",
|
|
67752
68787
|
"requestBody": {
|
|
67753
68788
|
"required": true,
|
|
67754
68789
|
"content": {
|
|
@@ -67756,113 +68791,21 @@
|
|
|
67756
68791
|
"schema": {
|
|
67757
68792
|
"type": "object",
|
|
67758
68793
|
"properties": {
|
|
67759
|
-
"config": {
|
|
67760
|
-
"anyOf": [
|
|
67761
|
-
{
|
|
67762
|
-
"type": "null"
|
|
67763
|
-
},
|
|
67764
|
-
{
|
|
67765
|
-
"type": "object",
|
|
67766
|
-
"properties": {
|
|
67767
|
-
"action": {
|
|
67768
|
-
"anyOf": [
|
|
67769
|
-
{
|
|
67770
|
-
"type": "null"
|
|
67771
|
-
},
|
|
67772
|
-
{
|
|
67773
|
-
"type": "object",
|
|
67774
|
-
"properties": {
|
|
67775
|
-
"label": {
|
|
67776
|
-
"type": "string"
|
|
67777
|
-
},
|
|
67778
|
-
"path": {
|
|
67779
|
-
"type": "string"
|
|
67780
|
-
}
|
|
67781
|
-
},
|
|
67782
|
-
"required": [
|
|
67783
|
-
"label",
|
|
67784
|
-
"path"
|
|
67785
|
-
],
|
|
67786
|
-
"additionalProperties": false
|
|
67787
|
-
}
|
|
67788
|
-
]
|
|
67789
|
-
},
|
|
67790
|
-
"body": {
|
|
67791
|
-
"type": "array",
|
|
67792
|
-
"items": {
|
|
67793
|
-
"type": "string"
|
|
67794
|
-
}
|
|
67795
|
-
},
|
|
67796
|
-
"channel": {
|
|
67797
|
-
"anyOf": [
|
|
67798
|
-
{
|
|
67799
|
-
"const": "email"
|
|
67800
|
-
},
|
|
67801
|
-
{
|
|
67802
|
-
"const": "preferred"
|
|
67803
|
-
},
|
|
67804
|
-
{
|
|
67805
|
-
"const": "slack"
|
|
67806
|
-
}
|
|
67807
|
-
]
|
|
67808
|
-
},
|
|
67809
|
-
"communityId": {
|
|
67810
|
-
"type": "string"
|
|
67811
|
-
},
|
|
67812
|
-
"note": {
|
|
67813
|
-
"type": "string"
|
|
67814
|
-
},
|
|
67815
|
-
"programId": {
|
|
67816
|
-
"type": "string"
|
|
67817
|
-
},
|
|
67818
|
-
"subject": {
|
|
67819
|
-
"type": "string"
|
|
67820
|
-
}
|
|
67821
|
-
},
|
|
67822
|
-
"additionalProperties": false
|
|
67823
|
-
}
|
|
67824
|
-
]
|
|
67825
|
-
},
|
|
67826
|
-
"groupId": {
|
|
67827
|
-
"type": "string"
|
|
67828
|
-
},
|
|
67829
68794
|
"id": {
|
|
67830
68795
|
"type": "string"
|
|
67831
68796
|
},
|
|
67832
|
-
"
|
|
67833
|
-
"anyOf": [
|
|
67834
|
-
{
|
|
67835
|
-
"const": "add_to_program"
|
|
67836
|
-
},
|
|
67837
|
-
{
|
|
67838
|
-
"const": "invite_community"
|
|
67839
|
-
},
|
|
67840
|
-
{
|
|
67841
|
-
"const": "send_message"
|
|
67842
|
-
},
|
|
67843
|
-
{
|
|
67844
|
-
"const": "start_playbook"
|
|
67845
|
-
},
|
|
67846
|
-
{
|
|
67847
|
-
"const": "tell_hr"
|
|
67848
|
-
},
|
|
67849
|
-
{
|
|
67850
|
-
"const": "tell_manager"
|
|
67851
|
-
}
|
|
67852
|
-
]
|
|
67853
|
-
},
|
|
67854
|
-
"trigger": {
|
|
68797
|
+
"state": {
|
|
67855
68798
|
"anyOf": [
|
|
67856
68799
|
{
|
|
67857
|
-
"const": "
|
|
68800
|
+
"const": "active"
|
|
67858
68801
|
},
|
|
67859
68802
|
{
|
|
67860
|
-
"const": "
|
|
68803
|
+
"const": "paused"
|
|
67861
68804
|
}
|
|
67862
68805
|
]
|
|
67863
68806
|
},
|
|
67864
68807
|
"confirm": {
|
|
67865
|
-
"const": "groups.
|
|
68808
|
+
"const": "groups.setAutomationState"
|
|
67866
68809
|
},
|
|
67867
68810
|
"requestKey": {
|
|
67868
68811
|
"type": "string",
|
|
@@ -67871,9 +68814,8 @@
|
|
|
67871
68814
|
}
|
|
67872
68815
|
},
|
|
67873
68816
|
"required": [
|
|
67874
|
-
"
|
|
67875
|
-
"
|
|
67876
|
-
"trigger",
|
|
68817
|
+
"id",
|
|
68818
|
+
"state",
|
|
67877
68819
|
"confirm",
|
|
67878
68820
|
"requestKey"
|
|
67879
68821
|
],
|
|
@@ -67942,125 +68884,12 @@
|
|
|
67942
68884
|
{
|
|
67943
68885
|
"type": "object",
|
|
67944
68886
|
"properties": {
|
|
67945
|
-
"
|
|
67946
|
-
"type": "
|
|
67947
|
-
},
|
|
67948
|
-
"config": {
|
|
67949
|
-
"type": "object",
|
|
67950
|
-
"properties": {
|
|
67951
|
-
"action": {
|
|
67952
|
-
"anyOf": [
|
|
67953
|
-
{
|
|
67954
|
-
"type": "null"
|
|
67955
|
-
},
|
|
67956
|
-
{
|
|
67957
|
-
"type": "object",
|
|
67958
|
-
"properties": {
|
|
67959
|
-
"label": {
|
|
67960
|
-
"type": "string"
|
|
67961
|
-
},
|
|
67962
|
-
"path": {
|
|
67963
|
-
"type": "string"
|
|
67964
|
-
}
|
|
67965
|
-
},
|
|
67966
|
-
"required": [
|
|
67967
|
-
"label",
|
|
67968
|
-
"path"
|
|
67969
|
-
],
|
|
67970
|
-
"additionalProperties": false
|
|
67971
|
-
}
|
|
67972
|
-
]
|
|
67973
|
-
},
|
|
67974
|
-
"body": {
|
|
67975
|
-
"type": "array",
|
|
67976
|
-
"items": {
|
|
67977
|
-
"type": "string"
|
|
67978
|
-
}
|
|
67979
|
-
},
|
|
67980
|
-
"channel": {
|
|
67981
|
-
"anyOf": [
|
|
67982
|
-
{
|
|
67983
|
-
"const": "email"
|
|
67984
|
-
},
|
|
67985
|
-
{
|
|
67986
|
-
"const": "preferred"
|
|
67987
|
-
},
|
|
67988
|
-
{
|
|
67989
|
-
"const": "slack"
|
|
67990
|
-
}
|
|
67991
|
-
]
|
|
67992
|
-
},
|
|
67993
|
-
"communityId": {
|
|
67994
|
-
"type": "string"
|
|
67995
|
-
},
|
|
67996
|
-
"note": {
|
|
67997
|
-
"type": "string"
|
|
67998
|
-
},
|
|
67999
|
-
"programId": {
|
|
68000
|
-
"type": "string"
|
|
68001
|
-
},
|
|
68002
|
-
"subject": {
|
|
68003
|
-
"type": "string"
|
|
68004
|
-
}
|
|
68005
|
-
},
|
|
68006
|
-
"additionalProperties": false
|
|
68007
|
-
},
|
|
68008
|
-
"createdAt": {
|
|
68009
|
-
"type": "string",
|
|
68010
|
-
"format": "date-time"
|
|
68011
|
-
},
|
|
68012
|
-
"createdBy": {
|
|
68013
|
-
"anyOf": [
|
|
68014
|
-
{
|
|
68015
|
-
"type": "null"
|
|
68016
|
-
},
|
|
68017
|
-
{
|
|
68018
|
-
"type": "string"
|
|
68019
|
-
}
|
|
68020
|
-
]
|
|
68021
|
-
},
|
|
68022
|
-
"groupId": {
|
|
68023
|
-
"type": "string"
|
|
68887
|
+
"changed": {
|
|
68888
|
+
"type": "boolean"
|
|
68024
68889
|
},
|
|
68025
68890
|
"id": {
|
|
68026
68891
|
"type": "string"
|
|
68027
68892
|
},
|
|
68028
|
-
"kind": {
|
|
68029
|
-
"anyOf": [
|
|
68030
|
-
{
|
|
68031
|
-
"const": "add_to_program"
|
|
68032
|
-
},
|
|
68033
|
-
{
|
|
68034
|
-
"const": "invite_community"
|
|
68035
|
-
},
|
|
68036
|
-
{
|
|
68037
|
-
"const": "send_message"
|
|
68038
|
-
},
|
|
68039
|
-
{
|
|
68040
|
-
"const": "start_playbook"
|
|
68041
|
-
},
|
|
68042
|
-
{
|
|
68043
|
-
"const": "tell_hr"
|
|
68044
|
-
},
|
|
68045
|
-
{
|
|
68046
|
-
"const": "tell_manager"
|
|
68047
|
-
}
|
|
68048
|
-
]
|
|
68049
|
-
},
|
|
68050
|
-
"lastRunAt": {
|
|
68051
|
-
"anyOf": [
|
|
68052
|
-
{
|
|
68053
|
-
"type": "null"
|
|
68054
|
-
},
|
|
68055
|
-
{
|
|
68056
|
-
"type": "string",
|
|
68057
|
-
"format": "date-time"
|
|
68058
|
-
}
|
|
68059
|
-
]
|
|
68060
|
-
},
|
|
68061
|
-
"runs": {
|
|
68062
|
-
"type": "number"
|
|
68063
|
-
},
|
|
68064
68893
|
"state": {
|
|
68065
68894
|
"anyOf": [
|
|
68066
68895
|
{
|
|
@@ -68070,70 +68899,12 @@
|
|
|
68070
68899
|
"const": "paused"
|
|
68071
68900
|
}
|
|
68072
68901
|
]
|
|
68073
|
-
},
|
|
68074
|
-
"summary": {
|
|
68075
|
-
"type": "string"
|
|
68076
|
-
},
|
|
68077
|
-
"target": {
|
|
68078
|
-
"anyOf": [
|
|
68079
|
-
{
|
|
68080
|
-
"type": "null"
|
|
68081
|
-
},
|
|
68082
|
-
{
|
|
68083
|
-
"type": "object",
|
|
68084
|
-
"properties": {
|
|
68085
|
-
"id": {
|
|
68086
|
-
"type": "string"
|
|
68087
|
-
},
|
|
68088
|
-
"name": {
|
|
68089
|
-
"anyOf": [
|
|
68090
|
-
{
|
|
68091
|
-
"type": "null"
|
|
68092
|
-
},
|
|
68093
|
-
{
|
|
68094
|
-
"type": "string"
|
|
68095
|
-
}
|
|
68096
|
-
]
|
|
68097
|
-
}
|
|
68098
|
-
},
|
|
68099
|
-
"required": [
|
|
68100
|
-
"id",
|
|
68101
|
-
"name"
|
|
68102
|
-
],
|
|
68103
|
-
"additionalProperties": false
|
|
68104
|
-
}
|
|
68105
|
-
]
|
|
68106
|
-
},
|
|
68107
|
-
"trigger": {
|
|
68108
|
-
"anyOf": [
|
|
68109
|
-
{
|
|
68110
|
-
"const": "entered"
|
|
68111
|
-
},
|
|
68112
|
-
{
|
|
68113
|
-
"const": "left"
|
|
68114
|
-
}
|
|
68115
|
-
]
|
|
68116
|
-
},
|
|
68117
|
-
"updatedAt": {
|
|
68118
|
-
"type": "string",
|
|
68119
|
-
"format": "date-time"
|
|
68120
68902
|
}
|
|
68121
68903
|
},
|
|
68122
68904
|
"required": [
|
|
68123
|
-
"
|
|
68124
|
-
"config",
|
|
68125
|
-
"createdAt",
|
|
68126
|
-
"createdBy",
|
|
68127
|
-
"groupId",
|
|
68905
|
+
"changed",
|
|
68128
68906
|
"id",
|
|
68129
|
-
"
|
|
68130
|
-
"lastRunAt",
|
|
68131
|
-
"runs",
|
|
68132
|
-
"state",
|
|
68133
|
-
"summary",
|
|
68134
|
-
"target",
|
|
68135
|
-
"trigger",
|
|
68136
|
-
"updatedAt"
|
|
68907
|
+
"state"
|
|
68137
68908
|
],
|
|
68138
68909
|
"additionalProperties": false
|
|
68139
68910
|
},
|
|
@@ -68573,13 +69344,13 @@
|
|
|
68573
69344
|
}
|
|
68574
69345
|
},
|
|
68575
69346
|
"x-shuffl-access": "write",
|
|
68576
|
-
"x-shuffl-permission": "groups.
|
|
69347
|
+
"x-shuffl-permission": "groups.setAutomationState"
|
|
68577
69348
|
}
|
|
68578
69349
|
},
|
|
68579
|
-
"/manage/groups/
|
|
69350
|
+
"/manage/groups/setPlaybookAutoStart": {
|
|
68580
69351
|
"post": {
|
|
68581
|
-
"operationId": "groups.
|
|
68582
|
-
"summary": "
|
|
69352
|
+
"operationId": "groups.setPlaybookAutoStart",
|
|
69353
|
+
"summary": "Turn on, pause or remove a playbook’s rule that starts it on each new hire’s start date, for everyone or one group",
|
|
68583
69354
|
"requestBody": {
|
|
68584
69355
|
"required": true,
|
|
68585
69356
|
"content": {
|
|
@@ -68587,7 +69358,17 @@
|
|
|
68587
69358
|
"schema": {
|
|
68588
69359
|
"type": "object",
|
|
68589
69360
|
"properties": {
|
|
68590
|
-
"
|
|
69361
|
+
"groupId": {
|
|
69362
|
+
"anyOf": [
|
|
69363
|
+
{
|
|
69364
|
+
"type": "null"
|
|
69365
|
+
},
|
|
69366
|
+
{
|
|
69367
|
+
"type": "string"
|
|
69368
|
+
}
|
|
69369
|
+
]
|
|
69370
|
+
},
|
|
69371
|
+
"programId": {
|
|
68591
69372
|
"type": "string"
|
|
68592
69373
|
},
|
|
68593
69374
|
"state": {
|
|
@@ -68595,13 +69376,16 @@
|
|
|
68595
69376
|
{
|
|
68596
69377
|
"const": "active"
|
|
68597
69378
|
},
|
|
69379
|
+
{
|
|
69380
|
+
"const": "off"
|
|
69381
|
+
},
|
|
68598
69382
|
{
|
|
68599
69383
|
"const": "paused"
|
|
68600
69384
|
}
|
|
68601
69385
|
]
|
|
68602
69386
|
},
|
|
68603
69387
|
"confirm": {
|
|
68604
|
-
"const": "groups.
|
|
69388
|
+
"const": "groups.setPlaybookAutoStart"
|
|
68605
69389
|
},
|
|
68606
69390
|
"requestKey": {
|
|
68607
69391
|
"type": "string",
|
|
@@ -68610,7 +69394,7 @@
|
|
|
68610
69394
|
}
|
|
68611
69395
|
},
|
|
68612
69396
|
"required": [
|
|
68613
|
-
"
|
|
69397
|
+
"programId",
|
|
68614
69398
|
"state",
|
|
68615
69399
|
"confirm",
|
|
68616
69400
|
"requestKey"
|
|
@@ -68691,6 +69475,9 @@
|
|
|
68691
69475
|
{
|
|
68692
69476
|
"const": "active"
|
|
68693
69477
|
},
|
|
69478
|
+
{
|
|
69479
|
+
"const": "off"
|
|
69480
|
+
},
|
|
68694
69481
|
{
|
|
68695
69482
|
"const": "paused"
|
|
68696
69483
|
}
|
|
@@ -69140,7 +69927,7 @@
|
|
|
69140
69927
|
}
|
|
69141
69928
|
},
|
|
69142
69929
|
"x-shuffl-access": "write",
|
|
69143
|
-
"x-shuffl-permission": "groups.
|
|
69930
|
+
"x-shuffl-permission": "groups.setPlaybookAutoStart"
|
|
69144
69931
|
}
|
|
69145
69932
|
},
|
|
69146
69933
|
"/manage/groups/suggestions": {
|
|
@@ -134893,6 +135680,16 @@
|
|
|
134893
135680
|
}
|
|
134894
135681
|
]
|
|
134895
135682
|
},
|
|
135683
|
+
"autoStartPaused": {
|
|
135684
|
+
"anyOf": [
|
|
135685
|
+
{
|
|
135686
|
+
"const": false
|
|
135687
|
+
},
|
|
135688
|
+
{
|
|
135689
|
+
"const": true
|
|
135690
|
+
}
|
|
135691
|
+
]
|
|
135692
|
+
},
|
|
134896
135693
|
"buddy": {
|
|
134897
135694
|
"anyOf": [
|
|
134898
135695
|
{
|
|
@@ -140029,6 +140826,16 @@
|
|
|
140029
140826
|
}
|
|
140030
140827
|
]
|
|
140031
140828
|
},
|
|
140829
|
+
"autoStartPaused": {
|
|
140830
|
+
"anyOf": [
|
|
140831
|
+
{
|
|
140832
|
+
"const": false
|
|
140833
|
+
},
|
|
140834
|
+
{
|
|
140835
|
+
"const": true
|
|
140836
|
+
}
|
|
140837
|
+
]
|
|
140838
|
+
},
|
|
140032
140839
|
"buddy": {
|
|
140033
140840
|
"anyOf": [
|
|
140034
140841
|
{
|
|
@@ -140720,6 +141527,16 @@
|
|
|
140720
141527
|
}
|
|
140721
141528
|
]
|
|
140722
141529
|
},
|
|
141530
|
+
"autoStartPaused": {
|
|
141531
|
+
"anyOf": [
|
|
141532
|
+
{
|
|
141533
|
+
"const": false
|
|
141534
|
+
},
|
|
141535
|
+
{
|
|
141536
|
+
"const": true
|
|
141537
|
+
}
|
|
141538
|
+
]
|
|
141539
|
+
},
|
|
140723
141540
|
"buddy": {
|
|
140724
141541
|
"anyOf": [
|
|
140725
141542
|
{
|
|
@@ -200017,6 +200834,16 @@
|
|
|
200017
200834
|
}
|
|
200018
200835
|
]
|
|
200019
200836
|
},
|
|
200837
|
+
"autoStartPaused": {
|
|
200838
|
+
"anyOf": [
|
|
200839
|
+
{
|
|
200840
|
+
"const": false
|
|
200841
|
+
},
|
|
200842
|
+
{
|
|
200843
|
+
"const": true
|
|
200844
|
+
}
|
|
200845
|
+
]
|
|
200846
|
+
},
|
|
200020
200847
|
"buddy": {
|
|
200021
200848
|
"anyOf": [
|
|
200022
200849
|
{
|
|
@@ -252380,6 +253207,7 @@
|
|
|
252380
253207
|
"groups.sendMessage",
|
|
252381
253208
|
"groups.setAutomation",
|
|
252382
253209
|
"groups.setAutomationState",
|
|
253210
|
+
"groups.setPlaybookAutoStart",
|
|
252383
253211
|
"home.feed",
|
|
252384
253212
|
"home.places",
|
|
252385
253213
|
"home.preferences",
|
|
@@ -252839,6 +253667,7 @@
|
|
|
252839
253667
|
"groups.sendMessage",
|
|
252840
253668
|
"groups.setAutomation",
|
|
252841
253669
|
"groups.setAutomationState",
|
|
253670
|
+
"groups.setPlaybookAutoStart",
|
|
252842
253671
|
"home.feed",
|
|
252843
253672
|
"home.places",
|
|
252844
253673
|
"home.preferences",
|