@shuffl/api-contracts 0.2.0 → 0.2.1

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 CHANGED
@@ -12431,7 +12431,7 @@ export declare const contract: {
12431
12431
  sync: {
12432
12432
  connect: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
12433
12433
  fields: z.ZodRecord<z.ZodString, z.ZodString>;
12434
- provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12434
+ provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12435
12435
  confirm: z.ZodLiteral<"sync.connect">;
12436
12436
  requestKey: z.ZodString;
12437
12437
  }, z.core.$strict>, z.ZodObject<{
@@ -12540,7 +12540,7 @@ export declare const contract: {
12540
12540
  }, z.core.$strict>;
12541
12541
  category: z.ZodUnion<readonly [z.ZodLiteral<"chat">, z.ZodLiteral<"hris">, z.ZodLiteral<"identity">]>;
12542
12542
  docsHref: z.ZodOptional<z.ZodOptional<z.ZodString>>;
12543
- id: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12543
+ id: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12544
12544
  name: z.ZodString;
12545
12545
  via: z.ZodOptional<z.ZodOptional<z.ZodLiteral<"scim">>>;
12546
12546
  }, z.core.$strict>>;
@@ -12868,7 +12868,7 @@ export declare const contract: {
12868
12868
  used: z.ZodUnion<readonly [z.ZodNull, z.ZodNumber]>;
12869
12869
  }, z.core.$strict>>;
12870
12870
  connected: z.ZodLiteral<true>;
12871
- provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12871
+ provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
12872
12872
  providerName: z.ZodString;
12873
12873
  }, z.core.$strict>]>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
12874
12874
  BAD_REQUEST: {
@@ -14496,7 +14496,7 @@ export declare const managementContract: {
14496
14496
  sync: {
14497
14497
  connect: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
14498
14498
  fields: z.ZodRecord<z.ZodString, z.ZodString>;
14499
- provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
14499
+ provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
14500
14500
  confirm: z.ZodLiteral<"sync.connect">;
14501
14501
  requestKey: z.ZodString;
14502
14502
  }, z.core.$strict>, z.ZodObject<{
@@ -14605,7 +14605,7 @@ export declare const managementContract: {
14605
14605
  }, z.core.$strict>;
14606
14606
  category: z.ZodUnion<readonly [z.ZodLiteral<"chat">, z.ZodLiteral<"hris">, z.ZodLiteral<"identity">]>;
14607
14607
  docsHref: z.ZodOptional<z.ZodOptional<z.ZodString>>;
14608
- id: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
14608
+ id: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
14609
14609
  name: z.ZodString;
14610
14610
  via: z.ZodOptional<z.ZodOptional<z.ZodLiteral<"scim">>>;
14611
14611
  }, z.core.$strict>>;
@@ -15721,7 +15721,7 @@ export declare const managementContract: {
15721
15721
  used: z.ZodUnion<readonly [z.ZodNull, z.ZodNumber]>;
15722
15722
  }, z.core.$strict>>;
15723
15723
  connected: z.ZodLiteral<true>;
15724
- provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
15724
+ provider: z.ZodUnion<readonly [z.ZodLiteral<"bamboohr">, z.ZodLiteral<"deel">, z.ZodLiteral<"entra">, z.ZodLiteral<"google_team">, z.ZodLiteral<"google_workspace">, z.ZodLiteral<"gusto">, z.ZodLiteral<"hibob">, z.ZodLiteral<"jumpcloud">, z.ZodLiteral<"justworks">, z.ZodLiteral<"okta">, z.ZodLiteral<"onelogin">, z.ZodLiteral<"personio">, z.ZodLiteral<"rippling">, z.ZodLiteral<"scim">, z.ZodLiteral<"slack">, z.ZodLiteral<"workday">]>;
15725
15725
  providerName: z.ZodString;
15726
15726
  }, z.core.$strict>]>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
15727
15727
  BAD_REQUEST: {
@@ -1556,6 +1556,7 @@ const sync_currentOutput = z.strictObject({
1556
1556
  z.literal('deel'),
1557
1557
  z.literal('entra'),
1558
1558
  z.literal('google_team'),
1559
+ z.literal('google_workspace'),
1559
1560
  z.literal('gusto'),
1560
1561
  z.literal('hibob'),
1561
1562
  z.literal('jumpcloud'),
@@ -1607,6 +1608,7 @@ const sync_connectInput = z
1607
1608
  z.literal('deel'),
1608
1609
  z.literal('entra'),
1609
1610
  z.literal('google_team'),
1611
+ z.literal('google_workspace'),
1610
1612
  z.literal('gusto'),
1611
1613
  z.literal('hibob'),
1612
1614
  z.literal('jumpcloud'),
@@ -3055,6 +3057,7 @@ const timeOff_balancesOutput = z.union([
3055
3057
  z.literal('deel'),
3056
3058
  z.literal('entra'),
3057
3059
  z.literal('google_team'),
3060
+ z.literal('google_workspace'),
3058
3061
  z.literal('gusto'),
3059
3062
  z.literal('hibob'),
3060
3063
  z.literal('jumpcloud'),
package/openapi.json CHANGED
@@ -631,7 +631,7 @@
631
631
  "/manage/access/get": {
632
632
  "post": {
633
633
  "operationId": "access.get",
634
- "summary": "access.get",
634
+ "summary": "Read one person's workspace role and app access",
635
635
  "requestBody": {
636
636
  "required": true,
637
637
  "content": {
@@ -2468,7 +2468,7 @@
2468
2468
  "/manage/access/slackWaiting": {
2469
2469
  "post": {
2470
2470
  "operationId": "access.slackWaiting",
2471
- "summary": "access.slackWaiting",
2471
+ "summary": "List Slack members waiting for access to Shuffl",
2472
2472
  "requestBody": {
2473
2473
  "required": true,
2474
2474
  "content": {
@@ -3005,7 +3005,7 @@
3005
3005
  "/manage/assistant/conversations": {
3006
3006
  "post": {
3007
3007
  "operationId": "assistant.conversations",
3008
- "summary": "assistant.conversations",
3008
+ "summary": "List your conversations with Mello",
3009
3009
  "requestBody": {
3010
3010
  "required": true,
3011
3011
  "content": {
@@ -3504,7 +3504,7 @@
3504
3504
  "/manage/assistant/delete": {
3505
3505
  "post": {
3506
3506
  "operationId": "assistant.delete",
3507
- "summary": "assistant.delete",
3507
+ "summary": "Delete one of your conversations with Mello",
3508
3508
  "requestBody": {
3509
3509
  "required": true,
3510
3510
  "content": {
@@ -4041,7 +4041,7 @@
4041
4041
  "/manage/assistant/history": {
4042
4042
  "post": {
4043
4043
  "operationId": "assistant.history",
4044
- "summary": "assistant.history",
4044
+ "summary": "Read the messages in one of your conversations with Mello",
4045
4045
  "requestBody": {
4046
4046
  "required": true,
4047
4047
  "content": {
@@ -4669,7 +4669,7 @@
4669
4669
  "/manage/assistant/send": {
4670
4670
  "post": {
4671
4671
  "operationId": "assistant.send",
4672
- "summary": "assistant.send",
4672
+ "summary": "Ask Mello a question in a conversation",
4673
4673
  "requestBody": {
4674
4674
  "required": true,
4675
4675
  "content": {
@@ -5218,7 +5218,7 @@
5218
5218
  "/manage/assistant/stop": {
5219
5219
  "post": {
5220
5220
  "operationId": "assistant.stop",
5221
- "summary": "assistant.stop",
5221
+ "summary": "Stop an answer Mello is still writing",
5222
5222
  "requestBody": {
5223
5223
  "required": true,
5224
5224
  "content": {
@@ -6848,7 +6848,7 @@
6848
6848
  "/manage/badges/decideRequest": {
6849
6849
  "post": {
6850
6850
  "operationId": "badges.decideRequest",
6851
- "summary": "badges.decideRequest",
6851
+ "summary": "Approve or decline a request for a badge",
6852
6852
  "requestBody": {
6853
6853
  "required": true,
6854
6854
  "content": {
@@ -7964,7 +7964,7 @@
7964
7964
  "/manage/badges/hideOwn": {
7965
7965
  "post": {
7966
7966
  "operationId": "badges.hideOwn",
7967
- "summary": "badges.hideOwn",
7967
+ "summary": "Hide or show one of your badges on your profile",
7968
7968
  "requestBody": {
7969
7969
  "required": true,
7970
7970
  "content": {
@@ -10001,7 +10001,7 @@
10001
10001
  "/manage/badges/ofPerson": {
10002
10002
  "post": {
10003
10003
  "operationId": "badges.ofPerson",
10004
- "summary": "badges.ofPerson",
10004
+ "summary": "List a person's badges",
10005
10005
  "requestBody": {
10006
10006
  "required": true,
10007
10007
  "content": {
@@ -10633,7 +10633,7 @@
10633
10633
  "/manage/badges/request": {
10634
10634
  "post": {
10635
10635
  "operationId": "badges.request",
10636
- "summary": "badges.request",
10636
+ "summary": "Ask for a badge",
10637
10637
  "requestBody": {
10638
10638
  "required": true,
10639
10639
  "content": {
@@ -11173,7 +11173,7 @@
11173
11173
  "/manage/badges/revoke": {
11174
11174
  "post": {
11175
11175
  "operationId": "badges.revoke",
11176
- "summary": "badges.revoke",
11176
+ "summary": "Take a badge back from a person",
11177
11177
  "requestBody": {
11178
11178
  "required": true,
11179
11179
  "content": {
@@ -12898,7 +12898,7 @@
12898
12898
  "/manage/badges/setHidden": {
12899
12899
  "post": {
12900
12900
  "operationId": "badges.setHidden",
12901
- "summary": "badges.setHidden",
12901
+ "summary": "Hide or show a badge for the whole workspace",
12902
12902
  "requestBody": {
12903
12903
  "required": true,
12904
12904
  "content": {
@@ -15618,7 +15618,7 @@
15618
15618
  "/manage/celebrations/deliveries": {
15619
15619
  "post": {
15620
15620
  "operationId": "celebrations.deliveries",
15621
- "summary": "celebrations.deliveries",
15621
+ "summary": "List the celebration messages Shuffl sent",
15622
15622
  "requestBody": {
15623
15623
  "required": true,
15624
15624
  "content": {
@@ -16428,7 +16428,7 @@
16428
16428
  "/manage/celebrations/mine": {
16429
16429
  "post": {
16430
16430
  "operationId": "celebrations.mine",
16431
- "summary": "celebrations.mine",
16431
+ "summary": "List the celebrations you received",
16432
16432
  "requestBody": {
16433
16433
  "required": true,
16434
16434
  "content": {
@@ -16940,7 +16940,7 @@
16940
16940
  "/manage/celebrations/preferences": {
16941
16941
  "post": {
16942
16942
  "operationId": "celebrations.preferences",
16943
- "summary": "celebrations.preferences",
16943
+ "summary": "Read your birthday and work anniversary sharing preferences",
16944
16944
  "requestBody": {
16945
16945
  "required": true,
16946
16946
  "content": {
@@ -17597,7 +17597,7 @@
17597
17597
  "/manage/celebrations/preview": {
17598
17598
  "post": {
17599
17599
  "operationId": "celebrations.preview",
17600
- "summary": "celebrations.preview",
17600
+ "summary": "Preview a celebration message",
17601
17601
  "requestBody": {
17602
17602
  "required": true,
17603
17603
  "content": {
@@ -18387,7 +18387,7 @@
18387
18387
  "/manage/celebrations/program": {
18388
18388
  "post": {
18389
18389
  "operationId": "celebrations.program",
18390
- "summary": "celebrations.program",
18390
+ "summary": "Read the Celebrations settings",
18391
18391
  "requestBody": {
18392
18392
  "required": true,
18393
18393
  "content": {
@@ -18942,7 +18942,7 @@
18942
18942
  "/manage/celebrations/refresh": {
18943
18943
  "post": {
18944
18944
  "operationId": "celebrations.refresh",
18945
- "summary": "celebrations.refresh",
18945
+ "summary": "Look for new birthdays and work anniversaries to celebrate now",
18946
18946
  "requestBody": {
18947
18947
  "required": true,
18948
18948
  "content": {
@@ -20042,7 +20042,7 @@
20042
20042
  "/manage/celebrations/review": {
20043
20043
  "post": {
20044
20044
  "operationId": "celebrations.review",
20045
- "summary": "celebrations.review",
20045
+ "summary": "Review upcoming birthdays and work anniversaries",
20046
20046
  "requestBody": {
20047
20047
  "required": true,
20048
20048
  "content": {
@@ -21309,7 +21309,7 @@
21309
21309
  "/manage/celebrations/savePreferences": {
21310
21310
  "post": {
21311
21311
  "operationId": "celebrations.savePreferences",
21312
- "summary": "celebrations.savePreferences",
21312
+ "summary": "Save your birthday and work anniversary sharing preferences",
21313
21313
  "requestBody": {
21314
21314
  "required": true,
21315
21315
  "content": {
@@ -22915,7 +22915,7 @@
22915
22915
  "/manage/communities/archive": {
22916
22916
  "post": {
22917
22917
  "operationId": "communities.archive",
22918
- "summary": "communities.archive",
22918
+ "summary": "Archive a community",
22919
22919
  "requestBody": {
22920
22920
  "required": true,
22921
22921
  "content": {
@@ -26863,7 +26863,7 @@
26863
26863
  "/manage/communities/join": {
26864
26864
  "post": {
26865
26865
  "operationId": "communities.join",
26866
- "summary": "communities.join",
26866
+ "summary": "Join a community",
26867
26867
  "requestBody": {
26868
26868
  "required": true,
26869
26869
  "content": {
@@ -27424,7 +27424,7 @@
27424
27424
  "/manage/communities/leave": {
27425
27425
  "post": {
27426
27426
  "operationId": "communities.leave",
27427
- "summary": "communities.leave",
27427
+ "summary": "Leave a community",
27428
27428
  "requestBody": {
27429
27429
  "required": true,
27430
27430
  "content": {
@@ -28819,7 +28819,7 @@
28819
28819
  "/manage/communities/members": {
28820
28820
  "post": {
28821
28821
  "operationId": "communities.members",
28822
- "summary": "communities.members",
28822
+ "summary": "List a community's members",
28823
28823
  "requestBody": {
28824
28824
  "required": true,
28825
28825
  "content": {
@@ -29441,7 +29441,7 @@
29441
29441
  "/manage/communities/ofPerson": {
29442
29442
  "post": {
29443
29443
  "operationId": "communities.ofPerson",
29444
- "summary": "communities.ofPerson",
29444
+ "summary": "List the communities a person belongs to",
29445
29445
  "requestBody": {
29446
29446
  "required": true,
29447
29447
  "content": {
@@ -31694,7 +31694,7 @@
31694
31694
  "/manage/communities/setVisibility": {
31695
31695
  "post": {
31696
31696
  "operationId": "communities.setVisibility",
31697
- "summary": "communities.setVisibility",
31697
+ "summary": "Show or hide a community on your profile",
31698
31698
  "requestBody": {
31699
31699
  "required": true,
31700
31700
  "content": {
@@ -32235,7 +32235,7 @@
32235
32235
  "/manage/communities/sync": {
32236
32236
  "post": {
32237
32237
  "operationId": "communities.sync",
32238
- "summary": "communities.sync",
32238
+ "summary": "Sync a community's members with its Slack channel now",
32239
32239
  "requestBody": {
32240
32240
  "required": true,
32241
32241
  "content": {
@@ -34806,7 +34806,7 @@
34806
34806
  "/manage/credentials/api/list": {
34807
34807
  "post": {
34808
34808
  "operationId": "credentials.api.list",
34809
- "summary": "credentials.api.list",
34809
+ "summary": "List the workspace's API keys and what each can do",
34810
34810
  "requestBody": {
34811
34811
  "required": true,
34812
34812
  "content": {
@@ -37474,7 +37474,7 @@
37474
37474
  "/manage/credentials/api/revoke": {
37475
37475
  "post": {
37476
37476
  "operationId": "credentials.api.revoke",
37477
- "summary": "credentials.api.revoke",
37477
+ "summary": "Revoke an API key",
37478
37478
  "requestBody": {
37479
37479
  "required": true,
37480
37480
  "content": {
@@ -42360,7 +42360,7 @@
42360
42360
  "/manage/exports/team": {
42361
42361
  "post": {
42362
42362
  "operationId": "exports.team",
42363
- "summary": "exports.team",
42363
+ "summary": "Export the workspace's programs, people and introduction history",
42364
42364
  "requestBody": {
42365
42365
  "required": true,
42366
42366
  "content": {
@@ -53231,7 +53231,7 @@
53231
53231
  "/manage/hr/command": {
53232
53232
  "post": {
53233
53233
  "operationId": "hr.command",
53234
- "summary": "hr.command",
53234
+ "summary": "Claim, release, reply to, note, categorize, resolve or reopen an HR request",
53235
53235
  "requestBody": {
53236
53236
  "required": true,
53237
53237
  "content": {
@@ -54974,7 +54974,7 @@
54974
54974
  "/manage/hr/get": {
54975
54975
  "post": {
54976
54976
  "operationId": "hr.get",
54977
- "summary": "hr.get",
54977
+ "summary": "Read one HR request and its messages",
54978
54978
  "requestBody": {
54979
54979
  "required": true,
54980
54980
  "content": {
@@ -55784,7 +55784,7 @@
55784
55784
  "/manage/hr/list": {
55785
55785
  "post": {
55786
55786
  "operationId": "hr.list",
55787
- "summary": "hr.list",
55787
+ "summary": "List the HR requests you asked or can answer",
55788
55788
  "requestBody": {
55789
55789
  "required": true,
55790
55790
  "content": {
@@ -56402,7 +56402,7 @@
56402
56402
  "/manage/hr/readiness": {
56403
56403
  "post": {
56404
56404
  "operationId": "hr.readiness",
56405
- "summary": "hr.readiness",
56405
+ "summary": "Check whether HR requests have a destination and someone to answer them",
56406
56406
  "requestBody": {
56407
56407
  "required": true,
56408
56408
  "content": {
@@ -57447,7 +57447,7 @@
57447
57447
  "/manage/hr/renameTeam": {
57448
57448
  "post": {
57449
57449
  "operationId": "hr.renameTeam",
57450
- "summary": "hr.renameTeam",
57450
+ "summary": "Rename the HR team employees send requests to",
57451
57451
  "requestBody": {
57452
57452
  "required": true,
57453
57453
  "content": {
@@ -59115,7 +59115,7 @@
59115
59115
  "/manage/hr/settings": {
59116
59116
  "post": {
59117
59117
  "operationId": "hr.settings",
59118
- "summary": "hr.settings",
59118
+ "summary": "Read the HR team name and who answers HR requests",
59119
59119
  "requestBody": {
59120
59120
  "required": true,
59121
59121
  "content": {
@@ -60277,7 +60277,7 @@
60277
60277
  "/manage/hr/shareSources": {
60278
60278
  "post": {
60279
60279
  "operationId": "hr.shareSources",
60280
- "summary": "hr.shareSources",
60280
+ "summary": "List your recent Mello conversations that an HR request can include",
60281
60281
  "requestBody": {
60282
60282
  "required": true,
60283
60283
  "content": {
@@ -61948,7 +61948,7 @@
61948
61948
  "/manage/identities/list": {
61949
61949
  "post": {
61950
61950
  "operationId": "identities.list",
61951
- "summary": "identities.list",
61951
+ "summary": "List the Slack and web accounts linked to a person",
61952
61952
  "requestBody": {
61953
61953
  "required": true,
61954
61954
  "content": {
@@ -62485,7 +62485,7 @@
62485
62485
  "/manage/identities/slackAccounts": {
62486
62486
  "post": {
62487
62487
  "operationId": "identities.slackAccounts",
62488
- "summary": "identities.slackAccounts",
62488
+ "summary": "List Slack accounts that can be linked to people",
62489
62489
  "requestBody": {
62490
62490
  "required": true,
62491
62491
  "content": {
@@ -63533,7 +63533,7 @@
63533
63533
  "/manage/identities/webAccounts": {
63534
63534
  "post": {
63535
63535
  "operationId": "identities.webAccounts",
63536
- "summary": "identities.webAccounts",
63536
+ "summary": "List web accounts that can be linked to people",
63537
63537
  "requestBody": {
63538
63538
  "required": true,
63539
63539
  "content": {
@@ -64045,7 +64045,7 @@
64045
64045
  "/manage/integrations/authorize": {
64046
64046
  "post": {
64047
64047
  "operationId": "integrations.authorize",
64048
- "summary": "integrations.authorize",
64048
+ "summary": "Get the link that connects Slack, Google Drive or Notion to the workspace",
64049
64049
  "requestBody": {
64050
64050
  "required": true,
64051
64051
  "content": {
@@ -64531,7 +64531,7 @@
64531
64531
  "/manage/invitations/cancel": {
64532
64532
  "post": {
64533
64533
  "operationId": "invitations.cancel",
64534
- "summary": "invitations.cancel",
64534
+ "summary": "Cancel a pending workspace invitation",
64535
64535
  "requestBody": {
64536
64536
  "required": true,
64537
64537
  "content": {
@@ -65139,7 +65139,7 @@
65139
65139
  "/manage/invitations/candidates": {
65140
65140
  "post": {
65141
65141
  "operationId": "invitations.candidates",
65142
- "summary": "invitations.candidates",
65142
+ "summary": "List people in the directory who can be invited to the workspace",
65143
65143
  "requestBody": {
65144
65144
  "required": true,
65145
65145
  "content": {
@@ -67524,7 +67524,7 @@
67524
67524
  "/manage/invitations/list": {
67525
67525
  "post": {
67526
67526
  "operationId": "invitations.list",
67527
- "summary": "invitations.list",
67527
+ "summary": "List pending workspace invitations",
67528
67528
  "requestBody": {
67529
67529
  "required": true,
67530
67530
  "content": {
@@ -69737,7 +69737,7 @@
69737
69737
  "/manage/knowledge/connections/list": {
69738
69738
  "post": {
69739
69739
  "operationId": "knowledge.connections.list",
69740
- "summary": "knowledge.connections.list",
69740
+ "summary": "List connected Knowledge providers",
69741
69741
  "requestBody": {
69742
69742
  "required": true,
69743
69743
  "content": {
@@ -70539,7 +70539,7 @@
70539
70539
  "/manage/knowledge/connections/request": {
70540
70540
  "post": {
70541
70541
  "operationId": "knowledge.connections.request",
70542
- "summary": "knowledge.connections.request",
70542
+ "summary": "Ask an administrator to connect a Knowledge source",
70543
70543
  "requestBody": {
70544
70544
  "required": true,
70545
70545
  "content": {
@@ -71093,7 +71093,7 @@
71093
71093
  "/manage/knowledge/connections/requests": {
71094
71094
  "post": {
71095
71095
  "operationId": "knowledge.connections.requests",
71096
- "summary": "knowledge.connections.requests",
71096
+ "summary": "List requests to connect a Knowledge source",
71097
71097
  "requestBody": {
71098
71098
  "required": true,
71099
71099
  "content": {
@@ -71570,7 +71570,7 @@
71570
71570
  "/manage/knowledge/policies/coverage": {
71571
71571
  "post": {
71572
71572
  "operationId": "knowledge.policies.coverage",
71573
- "summary": "knowledge.policies.coverage",
71573
+ "summary": "Check which common HR policies Knowledge covers",
71574
71574
  "requestBody": {
71575
71575
  "required": true,
71576
71576
  "content": {
@@ -73474,7 +73474,7 @@
73474
73474
  "/manage/knowledge/sources/get": {
73475
73475
  "post": {
73476
73476
  "operationId": "knowledge.sources.get",
73477
- "summary": "knowledge.sources.get",
73477
+ "summary": "Read a Knowledge source",
73478
73478
  "requestBody": {
73479
73479
  "required": true,
73480
73480
  "content": {
@@ -74549,7 +74549,7 @@
74549
74549
  "/manage/knowledge/sources/history": {
74550
74550
  "post": {
74551
74551
  "operationId": "knowledge.sources.history",
74552
- "summary": "knowledge.sources.history",
74552
+ "summary": "List a Knowledge source's versions",
74553
74553
  "requestBody": {
74554
74554
  "required": true,
74555
74555
  "content": {
@@ -75798,7 +75798,7 @@
75798
75798
  "/manage/knowledge/sources/importWebsite": {
75799
75799
  "post": {
75800
75800
  "operationId": "knowledge.sources.importWebsite",
75801
- "summary": "knowledge.sources.importWebsite",
75801
+ "summary": "Import a website page into Knowledge for review",
75802
75802
  "requestBody": {
75803
75803
  "required": true,
75804
75804
  "content": {
@@ -76481,7 +76481,7 @@
76481
76481
  "/manage/knowledge/sources/list": {
76482
76482
  "post": {
76483
76483
  "operationId": "knowledge.sources.list",
76484
- "summary": "knowledge.sources.list",
76484
+ "summary": "List Knowledge sources",
76485
76485
  "requestBody": {
76486
76486
  "required": true,
76487
76487
  "content": {
@@ -78481,7 +78481,7 @@
78481
78481
  "/manage/knowledge/sources/refresh": {
78482
78482
  "post": {
78483
78483
  "operationId": "knowledge.sources.refresh",
78484
- "summary": "knowledge.sources.refresh",
78484
+ "summary": "Refresh a Knowledge source from its connected provider",
78485
78485
  "requestBody": {
78486
78486
  "required": true,
78487
78487
  "content": {
@@ -79641,7 +79641,7 @@
79641
79641
  "/manage/knowledge/sources/save": {
79642
79642
  "post": {
79643
79643
  "operationId": "knowledge.sources.save",
79644
- "summary": "knowledge.sources.save",
79644
+ "summary": "Save a Knowledge source draft",
79645
79645
  "requestBody": {
79646
79646
  "required": true,
79647
79647
  "content": {
@@ -80717,7 +80717,7 @@
80717
80717
  "/manage/knowledge/sources/search": {
80718
80718
  "post": {
80719
80719
  "operationId": "knowledge.sources.search",
80720
- "summary": "knowledge.sources.search",
80720
+ "summary": "Search Knowledge sources by title",
80721
80721
  "requestBody": {
80722
80722
  "required": true,
80723
80723
  "content": {
@@ -81200,7 +81200,7 @@
81200
81200
  "/manage/knowledge/sources/withdraw": {
81201
81201
  "post": {
81202
81202
  "operationId": "knowledge.sources.withdraw",
81203
- "summary": "knowledge.sources.withdraw",
81203
+ "summary": "Withdraw a published Knowledge source",
81204
81204
  "requestBody": {
81205
81205
  "required": true,
81206
81206
  "content": {
@@ -82301,7 +82301,7 @@
82301
82301
  "/manage/knowledge/uploads/appendPart": {
82302
82302
  "post": {
82303
82303
  "operationId": "knowledge.uploads.appendPart",
82304
- "summary": "knowledge.uploads.appendPart",
82304
+ "summary": "Upload the next part of a Knowledge file",
82305
82305
  "requestBody": {
82306
82306
  "required": true,
82307
82307
  "content": {
@@ -83012,7 +83012,7 @@
83012
83012
  "/manage/knowledge/uploads/complete": {
83013
83013
  "post": {
83014
83014
  "operationId": "knowledge.uploads.complete",
83015
- "summary": "knowledge.uploads.complete",
83015
+ "summary": "Finish a Knowledge file upload and start reading it",
83016
83016
  "requestBody": {
83017
83017
  "required": true,
83018
83018
  "content": {
@@ -83712,7 +83712,7 @@
83712
83712
  "/manage/knowledge/uploads/create": {
83713
83713
  "post": {
83714
83714
  "operationId": "knowledge.uploads.create",
83715
- "summary": "knowledge.uploads.create",
83715
+ "summary": "Start uploading a file to Knowledge",
83716
83716
  "requestBody": {
83717
83717
  "required": true,
83718
83718
  "content": {
@@ -84423,7 +84423,7 @@
84423
84423
  "/manage/knowledge/uploads/get": {
84424
84424
  "post": {
84425
84425
  "operationId": "knowledge.uploads.get",
84426
- "summary": "knowledge.uploads.get",
84426
+ "summary": "Read the progress of a Knowledge file upload",
84427
84427
  "requestBody": {
84428
84428
  "required": true,
84429
84429
  "content": {
@@ -85054,7 +85054,7 @@
85054
85054
  "/manage/knowledge/uploads/retry": {
85055
85055
  "post": {
85056
85056
  "operationId": "knowledge.uploads.retry",
85057
- "summary": "knowledge.uploads.retry",
85057
+ "summary": "Retry reading a Knowledge file that failed",
85058
85058
  "requestBody": {
85059
85059
  "required": true,
85060
85060
  "content": {
@@ -89632,7 +89632,7 @@
89632
89632
  "/manage/notifications/preferences": {
89633
89633
  "post": {
89634
89634
  "operationId": "notifications.preferences",
89635
- "summary": "notifications.preferences",
89635
+ "summary": "Read your notification preferences",
89636
89636
  "requestBody": {
89637
89637
  "required": true,
89638
89638
  "content": {
@@ -90264,7 +90264,7 @@
90264
90264
  "/manage/notifications/save": {
90265
90265
  "post": {
90266
90266
  "operationId": "notifications.save",
90267
- "summary": "notifications.save",
90267
+ "summary": "Save a notification preference",
90268
90268
  "requestBody": {
90269
90269
  "required": true,
90270
90270
  "content": {
@@ -91591,7 +91591,7 @@
91591
91591
  "/manage/onboarding/answerCheckIn": {
91592
91592
  "post": {
91593
91593
  "operationId": "onboarding.answerCheckIn",
91594
- "summary": "onboarding.answerCheckIn",
91594
+ "summary": "Answer your onboarding program’s help check-in: all good, or ask HR for help",
91595
91595
  "requestBody": {
91596
91596
  "required": true,
91597
91597
  "content": {
@@ -93918,7 +93918,7 @@
93918
93918
  "/manage/onboarding/assignBuddy": {
93919
93919
  "post": {
93920
93920
  "operationId": "onboarding.assignBuddy",
93921
- "summary": "onboarding.assignBuddy",
93921
+ "summary": "Assign an onboarding buddy to a new hire",
93922
93922
  "requestBody": {
93923
93923
  "required": true,
93924
93924
  "content": {
@@ -95161,7 +95161,7 @@
95161
95161
  "/manage/onboarding/candidates": {
95162
95162
  "post": {
95163
95163
  "operationId": "onboarding.candidates",
95164
- "summary": "onboarding.candidates",
95164
+ "summary": "List people who could be enrolled in onboarding",
95165
95165
  "requestBody": {
95166
95166
  "required": true,
95167
95167
  "content": {
@@ -96329,7 +96329,7 @@
96329
96329
  "/manage/onboarding/enrollmentPreview": {
96330
96330
  "post": {
96331
96331
  "operationId": "onboarding.enrollmentPreview",
96332
- "summary": "onboarding.enrollmentPreview",
96332
+ "summary": "Preview enrolling a new hire in onboarding",
96333
96333
  "requestBody": {
96334
96334
  "required": true,
96335
96335
  "content": {
@@ -98033,7 +98033,7 @@
98033
98033
  "/manage/onboarding/mine": {
98034
98034
  "post": {
98035
98035
  "operationId": "onboarding.mine",
98036
- "summary": "onboarding.mine",
98036
+ "summary": "Read your own onboarding plan and buddy asks",
98037
98037
  "requestBody": {
98038
98038
  "required": true,
98039
98039
  "content": {
@@ -98779,7 +98779,7 @@
98779
98779
  "/manage/onboarding/person": {
98780
98780
  "post": {
98781
98781
  "operationId": "onboarding.person",
98782
- "summary": "onboarding.person",
98782
+ "summary": "Read a new hire's onboarding plan",
98783
98783
  "requestBody": {
98784
98784
  "required": true,
98785
98785
  "content": {
@@ -99384,7 +99384,7 @@
99384
99384
  "/manage/onboarding/previewEnrollment": {
99385
99385
  "post": {
99386
99386
  "operationId": "onboarding.previewEnrollment",
99387
- "summary": "onboarding.previewEnrollment",
99387
+ "summary": "Preview the onboarding steps for a new hire",
99388
99388
  "requestBody": {
99389
99389
  "required": true,
99390
99390
  "content": {
@@ -100145,7 +100145,7 @@
100145
100145
  "/manage/onboarding/program": {
100146
100146
  "post": {
100147
100147
  "operationId": "onboarding.program",
100148
- "summary": "onboarding.program",
100148
+ "summary": "Read the Onboarding program settings",
100149
100149
  "requestBody": {
100150
100150
  "required": true,
100151
100151
  "content": {
@@ -101121,7 +101121,7 @@
101121
101121
  "/manage/onboarding/remove": {
101122
101122
  "post": {
101123
101123
  "operationId": "onboarding.remove",
101124
- "summary": "onboarding.remove",
101124
+ "summary": "Remove a new hire from onboarding",
101125
101125
  "requestBody": {
101126
101126
  "required": true,
101127
101127
  "content": {
@@ -101662,7 +101662,7 @@
101662
101662
  "/manage/onboarding/respondBuddy": {
101663
101663
  "post": {
101664
101664
  "operationId": "onboarding.respondBuddy",
101665
- "summary": "onboarding.respondBuddy",
101665
+ "summary": "Accept or decline being an onboarding buddy",
101666
101666
  "requestBody": {
101667
101667
  "required": true,
101668
101668
  "content": {
@@ -102210,7 +102210,7 @@
102210
102210
  "/manage/onboarding/retry": {
102211
102211
  "post": {
102212
102212
  "operationId": "onboarding.retry",
102213
- "summary": "onboarding.retry",
102213
+ "summary": "Retry a failed onboarding step",
102214
102214
  "requestBody": {
102215
102215
  "required": true,
102216
102216
  "content": {
@@ -103936,7 +103936,7 @@
103936
103936
  "/manage/onboarding/update": {
103937
103937
  "post": {
103938
103938
  "operationId": "onboarding.update",
103939
- "summary": "onboarding.update",
103939
+ "summary": "Change a new hire's onboarding start date or time zone",
103940
103940
  "requestBody": {
103941
103941
  "required": true,
103942
103942
  "content": {
@@ -104489,7 +104489,7 @@
104489
104489
  "/manage/operations/activity": {
104490
104490
  "post": {
104491
104491
  "operationId": "operations.activity",
104492
- "summary": "operations.activity",
104492
+ "summary": "Read the workspace's recent audit activity",
104493
104493
  "requestBody": {
104494
104494
  "required": true,
104495
104495
  "content": {
@@ -106124,7 +106124,7 @@
106124
106124
  "/manage/operations/status": {
106125
106125
  "post": {
106126
106126
  "operationId": "operations.status",
106127
- "summary": "operations.status",
106127
+ "summary": "Read the workspace delivery and provider health summary",
106128
106128
  "requestBody": {
106129
106129
  "required": true,
106130
106130
  "content": {
@@ -114087,7 +114087,7 @@
114087
114087
  "/manage/profiles/cover/delete": {
114088
114088
  "post": {
114089
114089
  "operationId": "profiles.cover.delete",
114090
- "summary": "profiles.cover.delete",
114090
+ "summary": "Remove your profile cover picture",
114091
114091
  "requestBody": {
114092
114092
  "required": true,
114093
114093
  "content": {
@@ -117119,7 +117119,7 @@
117119
117119
  "/manage/profiles/photo/delete": {
117120
117120
  "post": {
117121
117121
  "operationId": "profiles.photo.delete",
117122
- "summary": "profiles.photo.delete",
117122
+ "summary": "Remove your profile photo",
117123
117123
  "requestBody": {
117124
117124
  "required": true,
117125
117125
  "content": {
@@ -117656,7 +117656,7 @@
117656
117656
  "/manage/profiles/positions/delete": {
117657
117657
  "post": {
117658
117658
  "operationId": "profiles.positions.delete",
117659
- "summary": "profiles.positions.delete",
117659
+ "summary": "Remove a past position from your profile",
117660
117660
  "requestBody": {
117661
117661
  "required": true,
117662
117662
  "content": {
@@ -118197,7 +118197,7 @@
118197
118197
  "/manage/profiles/positions/save": {
118198
118198
  "post": {
118199
118199
  "operationId": "profiles.positions.save",
118200
- "summary": "profiles.positions.save",
118200
+ "summary": "Add or change a past position on your profile",
118201
118201
  "requestBody": {
118202
118202
  "required": true,
118203
118203
  "content": {
@@ -118785,7 +118785,7 @@
118785
118785
  "/manage/profiles/save": {
118786
118786
  "post": {
118787
118787
  "operationId": "profiles.save",
118788
- "summary": "profiles.save",
118788
+ "summary": "Save your own profile: pronouns, location, phone, bio, interests, links and what you are working on",
118789
118789
  "requestBody": {
118790
118790
  "required": true,
118791
118791
  "content": {
@@ -121220,7 +121220,7 @@
121220
121220
  "/manage/programs/people": {
121221
121221
  "post": {
121222
121222
  "operationId": "programs.people",
121223
- "summary": "programs.people",
121223
+ "summary": "List the people in a program and whether they take part",
121224
121224
  "requestBody": {
121225
121225
  "required": true,
121226
121226
  "content": {
@@ -121746,7 +121746,7 @@
121746
121746
  "/manage/programs/schedulePreview": {
121747
121747
  "post": {
121748
121748
  "operationId": "programs.schedulePreview",
121749
- "summary": "programs.schedulePreview",
121749
+ "summary": "Preview a program's upcoming rounds",
121750
121750
  "requestBody": {
121751
121751
  "required": true,
121752
121752
  "content": {
@@ -152687,7 +152687,7 @@
152687
152687
  "/manage/reports/answerFeedback": {
152688
152688
  "post": {
152689
152689
  "operationId": "reports.answerFeedback",
152690
- "summary": "reports.answerFeedback",
152690
+ "summary": "Read feedback on Mello's answers",
152691
152691
  "requestBody": {
152692
152692
  "required": true,
152693
152693
  "content": {
@@ -153228,7 +153228,7 @@
153228
153228
  "/manage/reports/connections": {
153229
153229
  "post": {
153230
153230
  "operationId": "reports.connections",
153231
- "summary": "reports.connections",
153231
+ "summary": "Read Connections insights",
153232
153232
  "requestBody": {
153233
153233
  "required": true,
153234
153234
  "content": {
@@ -153839,7 +153839,7 @@
153839
153839
  "/manage/reports/knowledge": {
153840
153840
  "post": {
153841
153841
  "operationId": "reports.knowledge",
153842
- "summary": "reports.knowledge",
153842
+ "summary": "Read Knowledge activity",
153843
153843
  "requestBody": {
153844
153844
  "required": true,
153845
153845
  "content": {
@@ -154973,7 +154973,7 @@
154973
154973
  "/manage/reports/knowledgeSource": {
154974
154974
  "post": {
154975
154975
  "operationId": "reports.knowledgeSource",
154976
- "summary": "reports.knowledgeSource",
154976
+ "summary": "Read activity for one Knowledge source",
154977
154977
  "requestBody": {
154978
154978
  "required": true,
154979
154979
  "content": {
@@ -159158,7 +159158,7 @@
159158
159158
  "/manage/reports/needsYou": {
159159
159159
  "post": {
159160
159160
  "operationId": "reports.needsYou",
159161
- "summary": "reports.needsYou",
159161
+ "summary": "Read HR request and Knowledge draft insights",
159162
159162
  "requestBody": {
159163
159163
  "required": true,
159164
159164
  "content": {
@@ -159917,7 +159917,7 @@
159917
159917
  "/manage/reports/onboarding": {
159918
159918
  "post": {
159919
159919
  "operationId": "reports.onboarding",
159920
- "summary": "reports.onboarding",
159920
+ "summary": "Read Onboarding insights",
159921
159921
  "requestBody": {
159922
159922
  "required": true,
159923
159923
  "content": {
@@ -160553,7 +160553,7 @@
160553
160553
  "/manage/reports/overview": {
160554
160554
  "post": {
160555
160555
  "operationId": "reports.overview",
160556
- "summary": "reports.overview",
160556
+ "summary": "Read the workspace overview figures",
160557
160557
  "requestBody": {
160558
160558
  "required": true,
160559
160559
  "content": {
@@ -162161,7 +162161,7 @@
162161
162161
  "/manage/reports/people": {
162162
162162
  "post": {
162163
162163
  "operationId": "reports.people",
162164
- "summary": "reports.people",
162164
+ "summary": "Read People insights: headcount, teams and growth",
162165
162165
  "requestBody": {
162166
162166
  "required": true,
162167
162167
  "content": {
@@ -162814,7 +162814,7 @@
162814
162814
  "/manage/runs/details": {
162815
162815
  "post": {
162816
162816
  "operationId": "runs.details",
162817
- "summary": "runs.details",
162817
+ "summary": "Read one introduction round and its pairs",
162818
162818
  "requestBody": {
162819
162819
  "required": true,
162820
162820
  "content": {
@@ -164412,7 +164412,7 @@
164412
164412
  "/manage/runs/history/get": {
164413
164413
  "post": {
164414
164414
  "operationId": "runs.history.get",
164415
- "summary": "runs.history.get",
164415
+ "summary": "Read one introduction round imported from the previous Shuffl",
164416
164416
  "requestBody": {
164417
164417
  "required": true,
164418
164418
  "content": {
@@ -165608,7 +165608,7 @@
165608
165608
  "/manage/runs/history/list": {
165609
165609
  "post": {
165610
165610
  "operationId": "runs.history.list",
165611
- "summary": "runs.history.list",
165611
+ "summary": "List introduction rounds imported from the previous Shuffl",
165612
165612
  "requestBody": {
165613
165613
  "required": true,
165614
165614
  "content": {
@@ -166543,7 +166543,7 @@
166543
166543
  "/manage/runs/list": {
166544
166544
  "post": {
166545
166545
  "operationId": "runs.list",
166546
- "summary": "runs.list",
166546
+ "summary": "List a program's introduction rounds",
166547
166547
  "requestBody": {
166548
166548
  "required": true,
166549
166549
  "content": {
@@ -169829,7 +169829,7 @@
169829
169829
  "/manage/support/assign": {
169830
169830
  "post": {
169831
169831
  "operationId": "support.assign",
169832
- "summary": "support.assign",
169832
+ "summary": "Assign a Shuffl support conversation",
169833
169833
  "requestBody": {
169834
169834
  "required": true,
169835
169835
  "content": {
@@ -170385,7 +170385,7 @@
170385
170385
  "/manage/support/close": {
170386
170386
  "post": {
170387
170387
  "operationId": "support.close",
170388
- "summary": "support.close",
170388
+ "summary": "Close a Shuffl support conversation",
170389
170389
  "requestBody": {
170390
170390
  "required": true,
170391
170391
  "content": {
@@ -170926,7 +170926,7 @@
170926
170926
  "/manage/support/create": {
170927
170927
  "post": {
170928
170928
  "operationId": "support.create",
170929
- "summary": "support.create",
170929
+ "summary": "Start a support conversation with Shuffl",
170930
170930
  "requestBody": {
170931
170931
  "required": true,
170932
170932
  "content": {
@@ -171538,7 +171538,7 @@
171538
171538
  "/manage/support/get": {
171539
171539
  "post": {
171540
171540
  "operationId": "support.get",
171541
- "summary": "support.get",
171541
+ "summary": "Read one Shuffl support conversation",
171542
171542
  "requestBody": {
171543
171543
  "required": true,
171544
171544
  "content": {
@@ -172228,7 +172228,7 @@
172228
172228
  "/manage/support/list": {
172229
172229
  "post": {
172230
172230
  "operationId": "support.list",
172231
- "summary": "support.list",
172231
+ "summary": "List the workspace's support conversations with Shuffl",
172232
172232
  "requestBody": {
172233
172233
  "required": true,
172234
172234
  "content": {
@@ -172775,7 +172775,7 @@
172775
172775
  "/manage/support/reply": {
172776
172776
  "post": {
172777
172777
  "operationId": "support.reply",
172778
- "summary": "support.reply",
172778
+ "summary": "Reply in a Shuffl support conversation",
172779
172779
  "requestBody": {
172780
172780
  "required": true,
172781
172781
  "content": {
@@ -173417,6 +173417,9 @@
173417
173417
  {
173418
173418
  "const": "google_team"
173419
173419
  },
173420
+ {
173421
+ "const": "google_workspace"
173422
+ },
173420
173423
  {
173421
173424
  "const": "gusto"
173422
173425
  },
@@ -174074,7 +174077,7 @@
174074
174077
  "/manage/sync/current": {
174075
174078
  "post": {
174076
174079
  "operationId": "sync.current",
174077
- "summary": "sync.current",
174080
+ "summary": "Read the People sync provider, its last sync and what it found",
174078
174081
  "requestBody": {
174079
174082
  "required": true,
174080
174083
  "content": {
@@ -174336,6 +174339,9 @@
174336
174339
  {
174337
174340
  "const": "google_team"
174338
174341
  },
174342
+ {
174343
+ "const": "google_workspace"
174344
+ },
174339
174345
  {
174340
174346
  "const": "gusto"
174341
174347
  },
@@ -175531,7 +175537,7 @@
175531
175537
  "/manage/sync/request": {
175532
175538
  "post": {
175533
175539
  "operationId": "sync.request",
175534
- "summary": "sync.request",
175540
+ "summary": "Ask for a People sync provider Shuffl does not support yet",
175535
175541
  "requestBody": {
175536
175542
  "required": true,
175537
175543
  "content": {
@@ -176068,7 +176074,7 @@
176068
176074
  "/manage/sync/run": {
176069
176075
  "post": {
176070
176076
  "operationId": "sync.run",
176071
- "summary": "sync.run",
176077
+ "summary": "Sync People from the connected provider now",
176072
176078
  "requestBody": {
176073
176079
  "required": true,
176074
176080
  "content": {
@@ -177708,7 +177714,7 @@
177708
177714
  "/manage/team/launchPost": {
177709
177715
  "post": {
177710
177716
  "operationId": "team.launchPost",
177711
- "summary": "team.launchPost",
177717
+ "summary": "Read the launch announcement for the workspace",
177712
177718
  "requestBody": {
177713
177719
  "required": true,
177714
177720
  "content": {
@@ -178168,7 +178174,7 @@
178168
178174
  "/manage/teams/connectionPermissions": {
178169
178175
  "post": {
178170
178176
  "operationId": "teams.connectionPermissions",
178171
- "summary": "teams.connectionPermissions",
178177
+ "summary": "List connections whose permissions are behind what Shuffl asks for",
178172
178178
  "requestBody": {
178173
178179
  "required": true,
178174
178180
  "content": {
@@ -179218,7 +179224,7 @@
179218
179224
  "/manage/teams/initialize": {
179219
179225
  "post": {
179220
179226
  "operationId": "teams.initialize",
179221
- "summary": "teams.initialize",
179227
+ "summary": "Finish setting up a new workspace",
179222
179228
  "requestBody": {
179223
179229
  "required": true,
179224
179230
  "content": {
@@ -180400,7 +180406,7 @@
180400
180406
  "/manage/teams/rename": {
180401
180407
  "post": {
180402
180408
  "operationId": "teams.rename",
180403
- "summary": "teams.rename",
180409
+ "summary": "Rename the workspace",
180404
180410
  "requestBody": {
180405
180411
  "required": true,
180406
180412
  "content": {
@@ -181474,7 +181480,7 @@
181474
181480
  "/manage/teams/saveAgentSetup": {
181475
181481
  "post": {
181476
181482
  "operationId": "teams.saveAgentSetup",
181477
- "summary": "teams.saveAgentSetup",
181483
+ "summary": "Choose the built-in assistant or an external agent for the workspace",
181478
181484
  "requestBody": {
181479
181485
  "required": true,
181480
181486
  "content": {
@@ -182078,7 +182084,7 @@
182078
182084
  "/manage/teams/saveSlackJoinAccess": {
182079
182085
  "post": {
182080
182086
  "operationId": "teams.saveSlackJoinAccess",
182081
- "summary": "teams.saveSlackJoinAccess",
182087
+ "summary": "Choose whether Slack members can join Shuffl on their own",
182082
182088
  "requestBody": {
182083
182089
  "required": true,
182084
182090
  "content": {
@@ -182619,7 +182625,7 @@
182619
182625
  "/manage/teams/saveSlackProfileLink": {
182620
182626
  "post": {
182621
182627
  "operationId": "teams.saveSlackProfileLink",
182622
- "summary": "teams.saveSlackProfileLink",
182628
+ "summary": "Turn the Shuffl profile link on Slack profiles on or off",
182623
182629
  "requestBody": {
182624
182630
  "required": true,
182625
182631
  "content": {
@@ -183160,7 +183166,7 @@
183160
183166
  "/manage/teams/setup": {
183161
183167
  "post": {
183162
183168
  "operationId": "teams.setup",
183163
- "summary": "teams.setup",
183169
+ "summary": "Read the workspace's setup checklist",
183164
183170
  "requestBody": {
183165
183171
  "required": true,
183166
183172
  "content": {
@@ -184066,7 +184072,7 @@
184066
184072
  "/manage/teams/slackChannels": {
184067
184073
  "post": {
184068
184074
  "operationId": "teams.slackChannels",
184069
- "summary": "teams.slackChannels",
184075
+ "summary": "List community channels in the connected Slack and what each would become",
184070
184076
  "requestBody": {
184071
184077
  "required": true,
184072
184078
  "content": {
@@ -184679,7 +184685,7 @@
184679
184685
  "/manage/teams/slackJoinAccess": {
184680
184686
  "post": {
184681
184687
  "operationId": "teams.slackJoinAccess",
184682
- "summary": "teams.slackJoinAccess",
184688
+ "summary": "Read whether Slack members can join Shuffl on their own",
184683
184689
  "requestBody": {
184684
184690
  "required": true,
184685
184691
  "content": {
@@ -185151,7 +185157,7 @@
185151
185157
  "/manage/teams/slackProfileLink": {
185152
185158
  "post": {
185153
185159
  "operationId": "teams.slackProfileLink",
185154
- "summary": "teams.slackProfileLink",
185160
+ "summary": "Read the Shuffl profile link setting for Slack profiles",
185155
185161
  "requestBody": {
185156
185162
  "required": true,
185157
185163
  "content": {
@@ -185710,7 +185716,7 @@
185710
185716
  "/manage/teams/status": {
185711
185717
  "post": {
185712
185718
  "operationId": "teams.status",
185713
- "summary": "teams.status",
185719
+ "summary": "Pause or resume the whole workspace",
185714
185720
  "requestBody": {
185715
185721
  "required": true,
185716
185722
  "content": {
@@ -187997,6 +188003,9 @@
187997
188003
  {
187998
188004
  "const": "google_team"
187999
188005
  },
188006
+ {
188007
+ "const": "google_workspace"
188008
+ },
188000
188009
  {
188001
188010
  "const": "gusto"
188002
188011
  },
@@ -188478,7 +188487,7 @@
188478
188487
  "/manage/units/archive": {
188479
188488
  "post": {
188480
188489
  "operationId": "units.archive",
188481
- "summary": "units.archive",
188490
+ "summary": "Archive a team or department in the People directory",
188482
188491
  "requestBody": {
188483
188492
  "required": true,
188484
188493
  "content": {
@@ -189019,7 +189028,7 @@
189019
189028
  "/manage/units/list": {
189020
189029
  "post": {
189021
189030
  "operationId": "units.list",
189022
- "summary": "units.list",
189031
+ "summary": "List the teams and departments in the People directory",
189023
189032
  "requestBody": {
189024
189033
  "required": true,
189025
189034
  "content": {
@@ -189551,7 +189560,7 @@
189551
189560
  "/manage/units/save": {
189552
189561
  "post": {
189553
189562
  "operationId": "units.save",
189554
- "summary": "units.save",
189563
+ "summary": "Create or rename a team or department in the People directory",
189555
189564
  "requestBody": {
189556
189565
  "required": true,
189557
189566
  "content": {
@@ -190151,7 +190160,7 @@
190151
190160
  "/manage/users/activity": {
190152
190161
  "post": {
190153
190162
  "operationId": "users.activity",
190154
- "summary": "users.activity",
190163
+ "summary": "Read a person's recent activity in Shuffl",
190155
190164
  "requestBody": {
190156
190165
  "required": true,
190157
190166
  "content": {
@@ -191631,7 +191640,7 @@
191631
191640
  "/manage/users/blockedPairs": {
191632
191641
  "post": {
191633
191642
  "operationId": "users.blockedPairs",
191634
- "summary": "users.blockedPairs",
191643
+ "summary": "List pairs of people who are never introduced",
191635
191644
  "requestBody": {
191636
191645
  "required": true,
191637
191646
  "content": {
@@ -192124,7 +192133,7 @@
192124
192133
  "/manage/users/blockPair": {
192125
192134
  "post": {
192126
192135
  "operationId": "users.blockPair",
192127
- "summary": "users.blockPair",
192136
+ "summary": "Stop two people from being introduced to each other",
192128
192137
  "requestBody": {
192129
192138
  "required": true,
192130
192139
  "content": {
@@ -192669,7 +192678,7 @@
192669
192678
  "/manage/users/details": {
192670
192679
  "post": {
192671
192680
  "operationId": "users.details",
192672
- "summary": "users.details",
192681
+ "summary": "Read one person's People directory record",
192673
192682
  "requestBody": {
192674
192683
  "required": true,
192675
192684
  "content": {
@@ -193468,7 +193477,7 @@
193468
193477
  "/manage/users/filterOptions": {
193469
193478
  "post": {
193470
193479
  "operationId": "users.filterOptions",
193471
- "summary": "users.filterOptions",
193480
+ "summary": "List the teams, departments, managers and locations People can filter by",
193472
193481
  "requestBody": {
193473
193482
  "required": true,
193474
193483
  "content": {
@@ -193996,7 +194005,7 @@
193996
194005
  "/manage/users/managerHistory": {
193997
194006
  "post": {
193998
194007
  "operationId": "users.managerHistory",
193999
- "summary": "users.managerHistory",
194008
+ "summary": "Read a person's recorded manager history",
194000
194009
  "requestBody": {
194001
194010
  "required": true,
194002
194011
  "content": {
@@ -194563,7 +194572,7 @@
194563
194572
  "/manage/users/managers": {
194564
194573
  "post": {
194565
194574
  "operationId": "users.managers",
194566
- "summary": "users.managers",
194575
+ "summary": "List the managers in the People directory",
194567
194576
  "requestBody": {
194568
194577
  "required": true,
194569
194578
  "content": {
@@ -195038,7 +195047,7 @@
195038
195047
  "/manage/users/page": {
195039
195048
  "post": {
195040
195049
  "operationId": "users.page",
195041
- "summary": "users.page",
195050
+ "summary": "List people in the People directory: search, or filter by team, department, manager, location, access or workspace role such as owner, admin or HR responder",
195042
195051
  "requestBody": {
195043
195052
  "required": true,
195044
195053
  "content": {
@@ -195942,7 +195951,7 @@
195942
195951
  "/manage/users/participants": {
195943
195952
  "post": {
195944
195953
  "operationId": "users.participants",
195945
- "summary": "users.participants",
195954
+ "summary": "List the people who take part in programs",
195946
195955
  "requestBody": {
195947
195956
  "required": true,
195948
195957
  "content": {
@@ -196773,7 +196782,7 @@
196773
196782
  "/manage/users/participation": {
196774
196783
  "post": {
196775
196784
  "operationId": "users.participation",
196776
- "summary": "users.participation",
196785
+ "summary": "Opt a person in to or out of a program",
196777
196786
  "requestBody": {
196778
196787
  "required": true,
196779
196788
  "content": {
@@ -197374,7 +197383,7 @@
197374
197383
  "/manage/users/profile": {
197375
197384
  "post": {
197376
197385
  "operationId": "users.profile",
197377
- "summary": "users.profile",
197386
+ "summary": "Edit a person's profile as an administrator",
197378
197387
  "requestBody": {
197379
197388
  "required": true,
197380
197389
  "content": {
@@ -199710,7 +199719,7 @@
199710
199719
  "/manage/users/save": {
199711
199720
  "post": {
199712
199721
  "operationId": "users.save",
199713
- "summary": "users.save",
199722
+ "summary": "Change someone's People directory record as an administrator: name, job title, manager, team, department or start date",
199714
199723
  "requestBody": {
199715
199724
  "required": true,
199716
199725
  "content": {
package/package.json CHANGED
@@ -40,5 +40,5 @@
40
40
  "sideEffects": false,
41
41
  "type": "module",
42
42
  "types": "./dist/index.d.ts",
43
- "version": "0.2.0"
43
+ "version": "0.2.1"
44
44
  }