{"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"Shuffl API token","scheme":"bearer","type":"http"}}},"info":{"description":"Team-bound API tokens. SDK and CLI operations share the same contracts and authorization.","title":"Shuffl API","version":"1.0.0"},"security":[{"bearerAuth":[]}],"servers":[{"url":"/api/v1"}],"openapi":"3.1.1","paths":{"/manage/access/enableSlack":{"post":{"operationId":"access.enableSlack","summary":"Give these Slack people employee access","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"markEmployed":{"anyOf":[{"const":false},{"const":true}]},"personIds":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"confirm":{"const":"access.enableSlack"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personIds","reason","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"enabled":{"type":"array","items":{"type":"string"}},"skipped":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string"},"reason":{"anyOf":[{"const":"bot"},{"const":"employment_ended"},{"const":"not_found"},{"const":"not_pending"},{"const":"provisioning_denied"},{"const":"slack_inactive"},{"const":"slack_unavailable"}]}},"required":["personId","reason"],"additionalProperties":false}}},"required":["enabled","skipped"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"access.enableSlack"}},"/manage/access/get":{"post":{"operationId":"access.get","summary":"Read one person's workspace role and app access","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"object","properties":{"employment":{"anyOf":[{"const":"employed"},{"const":"ended"},{"const":"on_leave"},{"const":"unknown"}]},"personId":{"type":"string"},"provisioningActive":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"revision":{"type":"number"},"status":{"anyOf":[{"const":"enabled"},{"const":"pending"},{"const":"suspended"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["employment","personId","provisioningActive","revision","status","teamId","updatedAt"],"additionalProperties":false},"actorRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"history":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"membership":{"anyOf":[{"type":"null"},{"type":"object","properties":{"companyRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"isSelf":{"type":"boolean"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["companyRole","isSelf","role"],"additionalProperties":false}]}},"required":["access","actorRole","history","membership"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"access.get"}},"/manage/access/save":{"post":{"operationId":"access.save","summary":"Change employee product access","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employment":{"anyOf":[{"const":"employed"},{"const":"ended"},{"const":"on_leave"},{"const":"unknown"}]},"expectedRevision":{"type":"number"},"personId":{"type":"string"},"reason":{"type":"string"},"status":{"anyOf":[{"const":"enabled"},{"const":"pending"},{"const":"suspended"}]},"confirm":{"const":"access.save"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["employment","expectedRevision","personId","reason","status","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revision":{"type":"number"},"saved":{"type":"boolean"}},"required":["revision","saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"access.save"}},"/manage/access/saveRole":{"post":{"operationId":"access.saveRole","summary":"Change a member’s team role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"personId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"confirm":{"const":"access.saveRole"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRole","personId","role","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["role"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"access.saveRole"}},"/manage/access/slackWaiting":{"post":{"operationId":"access.slackWaiting","summary":"List Slack members waiting for access to Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"people":{"type":"array","items":{"type":"object","properties":{"blocked":{"anyOf":[{"type":"null"},{"const":"bot"},{"const":"employment_ended"},{"const":"not_found"},{"const":"not_pending"},{"const":"provisioning_denied"},{"const":"slack_inactive"},{"const":"slack_unavailable"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employment":{"anyOf":[{"const":"employed"},{"const":"ended"},{"const":"on_leave"},{"const":"unknown"}]},"id":{"type":"string"},"name":{"type":"string"}},"required":["blocked","email","employment","id","name"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["people","truncated"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"access.slackWaiting"}},"/manage/assistant/conversations":{"post":{"operationId":"assistant.conversations","summary":"List your conversations with Mello","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"channel":{"anyOf":[{"const":"slack"},{"const":"web"}]},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["channel","expiresAt","id","slackUrl","title","updatedAt"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"assistant.conversations"}},"/manage/assistant/delete":{"post":{"operationId":"assistant.delete","summary":"Delete one of your conversations with Mello","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["id","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"deleted":{"type":"boolean"}},"required":["deleted"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"assistant.delete"}},"/manage/assistant/history":{"post":{"operationId":"assistant.history","summary":"Read the messages in one of your conversations with Mello","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"expiresAt":{"type":"string","format":"date-time"},"messages":{"type":"array","items":{"type":"object","properties":{"citations":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string"},"kind":{"anyOf":[{"const":"directory"},{"const":"knowledge"},{"const":"manager"}]},"passageId":{"type":"string"},"quote":{"type":"string"},"sourceId":{"type":"string"},"title":{"type":"string"},"versionId":{"type":"string"}},"required":["href","passageId","quote","sourceId","title","versionId"],"additionalProperties":false}},"id":{"type":"string"},"kind":{"anyOf":[{"type":"null"},{"const":"answer"},{"const":"clarification"},{"const":"unavailable"}]},"notice":{"anyOf":[{"type":"null"},{"const":"sources_unavailable"}]},"role":{"anyOf":[{"const":"assistant"},{"const":"system"},{"const":"user"}]},"text":{"type":"string"}},"required":["citations","id","kind","notice","role","text"],"additionalProperties":false}},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"leaseUntil":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"status":{"anyOf":[{"const":"cancelled"},{"const":"completed"},{"const":"failed"},{"const":"processing"},{"const":"queued"}]}},"required":["id","leaseUntil","status"],"additionalProperties":false}}},"required":["expiresAt","messages","turns"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"assistant.history"}},"/manage/assistant/send":{"post":{"operationId":"assistant.send","summary":"Ask Mello a question in a conversation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conversationId":{"type":"string"},"requestId":{"type":"string"},"text":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["conversationId","requestId","text","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"requestId":{"type":"string"},"status":{"type":"string"}},"required":["requestId","status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"assistant.send"}},"/manage/assistant/stop":{"post":{"operationId":"assistant.stop","summary":"Stop an answer Mello is still writing","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["requestId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"stopped":{"type":"boolean"}},"required":["stopped"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"assistant.stop"}},"/manage/badges/award":{"post":{"operationId":"badges.award","summary":"Give a badge you own to a person","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"personId":{"type":"string"},"reason":{"type":"string"},"confirm":{"const":"badges.award"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"awarded":{"type":"boolean"}},"required":["awarded"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.award"}},"/manage/badges/claim":{"post":{"operationId":"badges.claim","summary":"Claim a badge with its code","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"confirm":{"const":"badges.claim"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["code","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"badgeId":{"type":"string"},"name":{"type":"string"}},"required":["badgeId","name"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.claim"}},"/manage/badges/decideRequest":{"post":{"operationId":"badges.decideRequest","summary":"Approve or decline a request for a badge","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"approve":{"type":"boolean"},"requestId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["approve","requestId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"decided":{"type":"boolean"}},"required":["decided"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.decideRequest"}},"/manage/badges/generatePicture":{"post":{"operationId":"badges.generatePicture","summary":"Draw an AI picture for a badge you own. Keeps a picture already set unless replace is true; idea says what to draw","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"idea":{"type":"string"},"replace":{"anyOf":[{"const":false},{"const":true}]},"confirm":{"const":"badges.generatePicture"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"generated"},{"const":"kept"},{"const":"pending"}]}},"required":["imageUrl","status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.generatePicture"}},"/manage/badges/hideOwn":{"post":{"operationId":"badges.hideOwn","summary":"Hide or show one of your badges on your profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"hidden":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","hidden","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.hideOwn"}},"/manage/badges/holders":{"post":{"operationId":"badges.holders","summary":"List the people who hold a badge, as far as each lets you see","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"}},"required":["badgeId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"badge":{"type":"object","properties":{"automaticKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"awardMode":{"anyOf":[{"const":"automatic"},{"const":"claim_code"},{"const":"owner"},{"const":"request"}]},"description":{"type":"string"},"hidden":{"type":"boolean"},"id":{"type":"string"},"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"kind":{"anyOf":[{"const":"custom"},{"const":"event"},{"const":"program"},{"const":"release"},{"const":"role"},{"const":"tenure"}]},"name":{"type":"string"}},"required":["automaticKey","awardMode","description","hidden","id","imageUrl","kind","name"],"additionalProperties":false},"canRemove":{"type":"boolean"},"hiddenCount":{"type":"number"},"holders":{"type":"array","items":{"type":"object","properties":{"awardedAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["awardedAt","id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["badge","canRemove","hiddenCount","holders","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"badges.holders"}},"/manage/badges/list":{"post":{"operationId":"badges.list","summary":"List the team’s badges, who holds them and any open requests you decide","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"automaticKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"awardMode":{"anyOf":[{"const":"automatic"},{"const":"claim_code"},{"const":"owner"},{"const":"request"}]},"canAward":{"type":"boolean"},"canEdit":{"type":"boolean"},"claimCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"claimUntil":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"description":{"type":"string"},"hidden":{"type":"boolean"},"holders":{"type":"number"},"id":{"type":"string"},"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"kind":{"anyOf":[{"const":"custom"},{"const":"event"},{"const":"program"},{"const":"release"},{"const":"role"},{"const":"tenure"}]},"mine":{"anyOf":[{"type":"null"},{"const":"held"},{"const":"requested"}]},"moderators":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"preview":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"requests":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"message":{"type":"string"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"required":["createdAt","id","message","person"],"additionalProperties":false}}},"required":["automaticKey","awardMode","canAward","canEdit","claimCode","claimUntil","description","hidden","holders","id","imageUrl","kind","mine","moderators","name","owners","preview","requests"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"badges.list"}},"/manage/badges/ofPerson":{"post":{"operationId":"badges.ofPerson","summary":"List a person's badges","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"badges":{"type":"array","items":{"type":"object","properties":{"ask":{"anyOf":[{"type":"null"},{"const":"open"},{"const":"requested"}]},"automaticKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"awardedAt":{"type":"string","format":"date-time"},"awardedBy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}]},"badgeId":{"type":"string"},"description":{"type":"string"},"hidden":{"type":"boolean"},"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"kind":{"anyOf":[{"const":"custom"},{"const":"event"},{"const":"program"},{"const":"release"},{"const":"role"},{"const":"tenure"}]},"name":{"type":"string"},"reason":{"type":"string"}},"required":["ask","automaticKey","awardedAt","awardedBy","badgeId","description","hidden","imageUrl","kind","name","reason"],"additionalProperties":false}},"hidden":{"type":"boolean"}},"required":["badges","hidden"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"badges.ofPerson"}},"/manage/badges/request":{"post":{"operationId":"badges.request","summary":"Ask for a badge","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"message":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"requested":{"type":"boolean"}},"required":["requested"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.request"}},"/manage/badges/revoke":{"post":{"operationId":"badges.revoke","summary":"Take a badge back from a person","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"personId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","personId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revoked":{"type":"boolean"}},"required":["revoked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.revoke"}},"/manage/badges/save":{"post":{"operationId":"badges.save","summary":"Create or edit a badge you own","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"awardMode":{"anyOf":[{"const":"claim_code"},{"const":"owner"},{"const":"request"}]},"claimUntil":{"anyOf":[{"type":"null"},{"type":"string"}]},"description":{"type":"string"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"custom"},{"const":"event"},{"const":"program"},{"const":"release"},{"const":"role"},{"const":"tenure"}]},"moderatorIds":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"ownerIds":{"type":"array","items":{"type":"string"}},"template":{"type":"object","properties":{"id":{"type":"string"},"picture":{"anyOf":[{"const":"none"},{"const":"other"},{"const":"template"}]}},"required":["id","picture"],"additionalProperties":false},"confirm":{"const":"badges.save"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["awardMode","kind","name","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.save"}},"/manage/badges/saveSettings":{"post":{"operationId":"badges.saveSettings","summary":"Turn badge offers from praise on or off, and choose the launch channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"launchChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"praiseOffers":{"type":"boolean"},"confirm":{"const":"badges.saveSettings"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["launchChannelId","praiseOffers","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.saveSettings"}},"/manage/badges/setHidden":{"post":{"operationId":"badges.setHidden","summary":"Hide or show a badge for the whole workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"hidden":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","hidden","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.setHidden"}},"/manage/badges/settings":{"post":{"operationId":"badges.settings","summary":"Read the badge suggestion settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"launchChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"launchChannelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"praiseOffers":{"type":"boolean"}},"required":["launchChannelId","launchChannelName","praiseOffers"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"badges.settings"}},"/manage/badges/uploadPicture":{"post":{"operationId":"badges.uploadPicture","summary":"Set a badge picture from a PNG, JPEG or WebP picture sent as base64, for a badge you own","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"badgeId":{"type":"string"},"image":{"type":"string"},"confirm":{"const":"badges.uploadPicture"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["badgeId","image","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["imageUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"badges.uploadPicture"}},"/manage/celebrations/card":{"post":{"operationId":"celebrations.card","summary":"Open a celebration card you can sign or were given","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cardId":{"type":"string"}},"required":["cardId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"deliverAt":{"type":"string","format":"date-time"},"deliveredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"milestone":{"type":"boolean"},"notes":{"type":"array","items":{"type":"object","properties":{"authorId":{"type":"string"},"body":{"type":"string"},"mine":{"type":"boolean"},"name":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["authorId","body","mine","name","updatedAt"],"additionalProperties":false}},"open":{"type":"boolean"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"role":{"anyOf":[{"const":"recipient"},{"const":"signer"}]},"signers":{"type":"number"},"title":{"type":"string"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["deliverAt","deliveredAt","eventType","id","milestone","notes","open","person","role","signers","title","years"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.card"}},"/manage/celebrations/cards":{"post":{"operationId":"celebrations.cards","summary":"List celebration cards to sign and cards you were given","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"received":{"type":"array","items":{"type":"object","properties":{"deliveredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"notes":{"type":"number"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["deliveredAt","eventType","id","notes","years"],"additionalProperties":false}},"toSign":{"type":"array","items":{"type":"object","properties":{"deliverAt":{"type":"string","format":"date-time"},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"name":{"type":"string"},"signed":{"type":"boolean"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["deliverAt","eventType","id","name","signed","years"],"additionalProperties":false}}},"required":["received","toSign"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.cards"}},"/manage/celebrations/deliveries":{"post":{"operationId":"celebrations.deliveries","summary":"List the celebration messages Shuffl sent","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"counts":{"type":"object","properties":{"history":{"type":"number"},"scheduled":{"type":"number"},"sent":{"type":"number"}},"required":["history","scheduled","sent"],"additionalProperties":false},"history":{"type":"array","items":{"type":"object","properties":{"attempts":{"type":"number"},"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"personId":{"type":"string"},"personName":{"type":"string"},"providerReceipt":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipientName":{"type":"string"},"scheduledAt":{"type":"string","format":"date-time"},"sentAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"state":{"anyOf":[{"const":"attempting"},{"const":"cancelled"},{"const":"failed"},{"const":"scheduled"},{"const":"sent"},{"const":"skipped"},{"const":"unknown"}]},"stateChangedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"timezone":{"type":"string"},"transport":{"anyOf":[{"const":"slack"},{"const":"web"}]},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["attempts","audience","eventType","id","personId","personName","providerReceipt","reason","recipientName","scheduledAt","sentAt","state","stateChangedAt","timezone","transport","years"],"additionalProperties":false}},"page":{"type":"number"},"pageSize":{"type":"number"},"upcoming":{"type":"array","items":{"type":"object","properties":{"attempts":{"type":"number"},"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"personId":{"type":"string"},"personName":{"type":"string"},"providerReceipt":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipientName":{"type":"string"},"scheduledAt":{"type":"string","format":"date-time"},"sentAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"state":{"anyOf":[{"const":"attempting"},{"const":"cancelled"},{"const":"failed"},{"const":"scheduled"},{"const":"sent"},{"const":"skipped"},{"const":"unknown"}]},"stateChangedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"timezone":{"type":"string"},"transport":{"anyOf":[{"const":"slack"},{"const":"web"}]},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["attempts","audience","eventType","id","personId","personName","providerReceipt","reason","recipientName","scheduledAt","sentAt","state","stateChangedAt","timezone","transport","years"],"additionalProperties":false}}},"required":["counts","history","page","pageSize","upcoming"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.deliveries"}},"/manage/celebrations/mine":{"post":{"operationId":"celebrations.mine","summary":"List the celebrations you received","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"sentAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"text":{"type":"string"},"transport":{"anyOf":[{"const":"slack"},{"const":"web"}]},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["eventType","id","sentAt","text","transport","years"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.mine"}},"/manage/celebrations/preferences":{"post":{"operationId":"celebrations.preferences","summary":"Read your birthday and work anniversary sharing preferences","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"anniversaryOptOut":{"type":"boolean"},"anniversaryShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"anniversaryShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"birthday":{"anyOf":[{"type":"null"},{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"}},"required":["day","month"],"additionalProperties":false}]},"birthdayOptOut":{"type":"boolean"},"birthdayShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"birthdayShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"},"revision":{"type":"number"},"sharing":{"type":"object","properties":{"anniversary":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false},"birthday":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false}},"required":["anniversary","birthday"],"additionalProperties":false},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["anniversaryOptOut","anniversaryShare","anniversaryShareChannelId","birthday","birthdayOptOut","birthdayShare","birthdayShareChannelId","personId","revision","sharing","updatedAt"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.preferences"}},"/manage/celebrations/preview":{"post":{"operationId":"celebrations.preview","summary":"Preview a celebration message","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"template":{"type":"string"}},"required":["audience","channelId","channelName","eventType","sendHour","sendMinute","template"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"fingerprint":{"type":"string"},"messages":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"audience":{"const":"person"},"recipient":{"type":"string"},"text":{"type":"string"},"transport":{"anyOf":[{"const":"slack"},{"const":"web"}]}},"required":["audience","recipient","text","transport"],"additionalProperties":false},{"type":"object","properties":{"audience":{"const":"channel"},"recipient":{"type":"string"},"text":{"type":"string"},"transport":{"const":"slack"}},"required":["audience","recipient","text","transport"],"additionalProperties":false},{"type":"object","properties":{"audience":{"const":"team"},"recipient":{"type":"string"},"text":{"type":"string"},"transport":{"const":"slack"}},"required":["audience","recipient","text","transport"],"additionalProperties":false}]}},"sample":{"anyOf":[{"type":"object","properties":{"consented":{"type":"boolean"},"expiresAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"personId":{"type":"string"},"scheduledAt":{"type":"string","format":"date-time"},"slack":{"type":"boolean"},"timezone":{"type":"string"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["consented","expiresAt","name","personId","scheduledAt","slack","timezone","years"],"additionalProperties":false},{"type":"object","properties":{"consented":{"type":"boolean"},"expiresAt":{"type":"null"},"name":{"type":"string"},"personId":{"type":"null"},"scheduledAt":{"type":"null"},"slack":{"type":"boolean"},"timezone":{"type":"string"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["consented","expiresAt","name","personId","scheduledAt","slack","timezone","years"],"additionalProperties":false}]},"settings":{"type":"object","properties":{"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"template":{"type":"string"}},"required":["audience","channelId","channelName","eventType","sendHour","sendMinute","template"],"additionalProperties":false},"sharedNote":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["fingerprint","messages","sample","settings","sharedNote"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.preview"}},"/manage/celebrations/program":{"post":{"operationId":"celebrations.program","summary":"Read the Celebrations settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"programs":{"type":"array","items":{"type":"object","properties":{"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"enabled":{"type":"boolean"},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"revision":{"type":"number"},"scheduled":{"type":"number"},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"template":{"type":"string"},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["audience","channelId","channelName","enabled","eventType","revision","scheduled","sendHour","sendMinute","template","updatedAt"],"additionalProperties":false}},"scheduled":{"type":"number"}},"required":["programs","scheduled"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.program"}},"/manage/celebrations/refresh":{"post":{"operationId":"celebrations.refresh","summary":"Look for new birthdays and work anniversaries to celebrate now","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"cancelled":{"type":"number"},"from":{"type":"string","format":"date-time"},"inserted":{"type":"number"},"people":{"type":"number"},"superseded":{"type":"number"},"to":{"type":"string","format":"date-time"},"updated":{"type":"number"}},"required":["cancelled","from","inserted","people","superseded","to","updated"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"celebrations.refresh"}},"/manage/celebrations/removeCardNote":{"post":{"operationId":"celebrations.removeCardNote","summary":"Remove your note from this celebration card","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cardId":{"type":"string"},"confirm":{"const":"celebrations.removeCardNote"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["cardId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"removed":{"type":"boolean"}},"required":["removed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"celebrations.removeCardNote"}},"/manage/celebrations/review":{"post":{"operationId":"celebrations.review","summary":"Review upcoming birthdays and work anniversaries","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"counts":{"type":"object","properties":{"anniversaryOptedOut":{"type":"number"},"birthdayNotAdded":{"type":"number"},"birthdayOptedOut":{"type":"number"},"noStartDate":{"type":"number"},"pending":{"type":"number"},"people":{"type":"number"},"total":{"type":"number"}},"required":["anniversaryOptedOut","birthdayNotAdded","birthdayOptedOut","noStartDate","pending","people","total"],"additionalProperties":false},"noStartDate":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"page":{"type":"number"},"pageSize":{"type":"number"},"rows":{"type":"array","items":{"type":"object","properties":{"celebration":{"anyOf":[{"const":"off"},{"const":"private"},{"const":"shared"}]},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"occurrenceDate":{"type":"string"},"personId":{"type":"string"},"personName":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"startsAt":{"type":"string","format":"date-time"},"state":{"anyOf":[{"const":"cancelled"},{"const":"pending"},{"const":"superseded"}]},"timezone":{"type":"string"},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["celebration","eventType","id","occurrenceDate","personId","personName","reason","startsAt","state","timezone","years"],"additionalProperties":false}},"window":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"required":["counts","noStartDate","page","pageSize","rows","window"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"celebrations.review"}},"/manage/celebrations/save":{"post":{"operationId":"celebrations.save","summary":"Save celebration settings; enabling them schedules messages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"enabled":{"type":"boolean"},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"expectedRevision":{"type":"number"},"previewFingerprint":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"template":{"type":"string"},"confirm":{"const":"celebrations.save"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["audience","channelId","channelName","enabled","eventType","expectedRevision","sendHour","sendMinute","template","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"cancelled":{"type":"number"},"changed":{"type":"boolean"},"revision":{"type":"number"},"scheduled":{"type":"number"}},"required":["cancelled","changed","revision","scheduled"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"celebrations.save"}},"/manage/celebrations/savePreferences":{"post":{"operationId":"celebrations.savePreferences","summary":"Save your birthday and work anniversary sharing preferences","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"anniversaryOptOut":{"type":"boolean"},"anniversaryShare":{"anyOf":[{"const":false},{"const":true}]},"birthday":{"anyOf":[{"type":"null"},{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"}},"required":["day","month"],"additionalProperties":false}]},"birthdayOptOut":{"type":"boolean"},"birthdayShare":{"anyOf":[{"const":false},{"const":true}]},"expectedRevision":{"type":"number"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["anniversaryOptOut","birthday","birthdayOptOut","expectedRevision","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"anniversaryOptOut":{"type":"boolean"},"anniversaryShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"anniversaryShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"birthday":{"anyOf":[{"type":"null"},{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"}},"required":["day","month"],"additionalProperties":false}]},"birthdayOptOut":{"type":"boolean"},"birthdayShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"birthdayShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"cancelledDeliveries":{"type":"number"},"changed":{"type":"boolean"},"detection":{"type":"null"},"revision":{"type":"number"},"sharing":{"type":"object","properties":{"anniversary":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false},"birthday":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false}},"required":["anniversary","birthday"],"additionalProperties":false},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["anniversaryOptOut","anniversaryShare","anniversaryShareChannelId","birthday","birthdayOptOut","birthdayShare","birthdayShareChannelId","cancelledDeliveries","changed","detection","revision","sharing","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"anniversaryOptOut":{"type":"boolean"},"anniversaryShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"anniversaryShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"birthday":{"anyOf":[{"type":"null"},{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"}},"required":["day","month"],"additionalProperties":false}]},"birthdayOptOut":{"type":"boolean"},"birthdayShare":{"anyOf":[{"const":"channel"},{"const":"private"},{"const":"team"}]},"birthdayShareChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"cancelledDeliveries":{"type":"number"},"changed":{"type":"boolean"},"detection":{"type":"object","properties":{"cancelled":{"type":"number"},"from":{"type":"string","format":"date-time"},"inserted":{"type":"number"},"people":{"type":"number"},"superseded":{"type":"number"},"to":{"type":"string","format":"date-time"},"updated":{"type":"number"}},"required":["cancelled","from","inserted","people","superseded","to","updated"],"additionalProperties":false},"revision":{"type":"number"},"sharing":{"type":"object","properties":{"anniversary":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false},"birthday":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"const":"channel"},{"const":"person"},{"const":"team"}]},"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"consented":{"type":"boolean"},"enabled":{"type":"boolean"}},"required":["audience","channelName","consented","enabled"],"additionalProperties":false}},"required":["anniversary","birthday"],"additionalProperties":false},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["anniversaryOptOut","anniversaryShare","anniversaryShareChannelId","birthday","birthdayOptOut","birthdayShare","birthdayShareChannelId","cancelledDeliveries","changed","detection","revision","sharing","updatedAt"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"celebrations.savePreferences"}},"/manage/celebrations/signCard":{"post":{"operationId":"celebrations.signCard","summary":"Sign this celebration card with your note","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"cardId":{"type":"string"},"confirm":{"const":"celebrations.signCard"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["body","cardId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"edited":{"type":"boolean"},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]}},"required":["edited","eventType"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"celebrations.signCard"}},"/manage/communities/archive":{"post":{"operationId":"communities.archive","summary":"Archive a community","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"archived":{"type":"boolean"}},"required":["archived"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.archive"}},"/manage/communities/channelSuggestions":{"post":{"operationId":"communities.channelSuggestions","summary":"List Slack channels, with the ones that look like communities suggested","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"anyOf":[{"const":"model"},{"const":"names"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"by":{"anyOf":[{"type":"null"},{"const":"ai"},{"const":"rule"}]},"channels":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"communityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"isMember":{"type":"boolean"},"isPrivate":{"type":"boolean"},"joinable":{"type":"boolean"},"memberCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"name":{"type":"string"},"purpose":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"suggested":{"type":"boolean"}},"required":["category","communityId","id","isMember","isPrivate","joinable","memberCount","name","purpose","reason","suggested"],"additionalProperties":false}},"status":{"anyOf":[{"const":"ready"},{"const":"unavailable"}]}},"required":["by","channels","status"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"communities.channelSuggestions"}},"/manage/communities/createCapabilities":{"post":{"operationId":"communities.createCapabilities","summary":"Read the current permission to create public or private community channels","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"private":{"type":"boolean"},"privateScopeRequested":{"type":"boolean"},"public":{"type":"boolean"}},"required":["private","privateScopeRequested","public"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"communities.createCapabilities"}},"/manage/communities/createSlackChannel":{"post":{"operationId":"communities.createSlackChannel","summary":"Create an explicitly public or private Slack channel as an authorized community owner or administrator, retaining its request id across retries","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"isPrivate":{"anyOf":[{"const":false},{"const":true}]},"name":{"type":"string"},"requestId":{"type":"string"},"confirm":{"const":"communities.createSlackChannel"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","requestId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"isPrivate":{"type":"boolean"},"name":{"type":"string"},"outcome":{"const":"created"}},"required":["id","isPrivate","name","outcome"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"null"},"isPrivate":{"type":"boolean"},"name":{"type":"string"},"outcome":{"const":"unknown"}},"required":["id","isPrivate","name","outcome"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.createSlackChannel"}},"/manage/communities/fromChannels":{"post":{"operationId":"communities.fromChannels","summary":"Create one community per chosen Slack channel, as an administrator","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"admission":{"anyOf":[{"const":"invite_only"},{"const":"open"}]},"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"channelId":{"type":"string"}},"required":["category","channelId"],"additionalProperties":false}},"confirm":{"const":"communities.fromChannels"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channels","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"communityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"name":{"type":"string"},"outcome":{"anyOf":[{"const":"admission_required"},{"const":"already"},{"const":"created"},{"const":"failed"},{"const":"invite_required"}]}},"required":["channelId","communityId","name","outcome"],"additionalProperties":false}}},"required":["results"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.fromChannels"}},"/manage/communities/generateCover":{"post":{"operationId":"communities.generateCover","summary":"Draw an AI cover for a community, as its owner, moderator or an administrator. Keeps a cover already set unless replace is true; idea says what to draw","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"idea":{"type":"string"},"replace":{"anyOf":[{"const":false},{"const":true}]},"confirm":{"const":"communities.generateCover"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"generated"},{"const":"kept"},{"const":"pending"}]}},"required":["coverUrl","status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.generateCover"}},"/manage/communities/invite":{"post":{"operationId":"communities.invite","summary":"Invite selected people to a community as its owner or administrator; each person must accept","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"personIds":{"type":"array","items":{"type":"string"}},"confirm":{"const":"communities.invite"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","personIds","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"invited":{"type":"number"}},"required":["invited"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.invite"}},"/manage/communities/join":{"post":{"operationId":"communities.join","summary":"Join a community","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"invitationId":{"type":"string"},"showOnProfile":{"anyOf":[{"const":false},{"const":true}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"joined":{"type":"boolean"},"slackInvite":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["joined","slackInvite"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.join"}},"/manage/communities/leave":{"post":{"operationId":"communities.leave","summary":"Leave a community","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"left":{"type":"boolean"},"slackChannelName":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["left","slackChannelName"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.leave"}},"/manage/communities/list":{"post":{"operationId":"communities.list","summary":"List communities with the members you may see","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"admission":{"anyOf":[{"const":"invite_only"},{"const":"open"}]},"canEdit":{"type":"boolean"},"canInvite":{"type":"boolean"},"canManageRoles":{"type":"boolean"},"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"description":{"type":"string"},"faces":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"id":{"type":"string"},"invitationId":{"anyOf":[{"type":"null"},{"type":"string"}]},"invitationPending":{"type":"boolean"},"joined":{"type":"boolean"},"knownMembers":{"type":"number"},"memberCount":{"type":"number"},"membersVisibility":{"anyOf":[{"const":"everyone"},{"const":"self_chosen"}]},"moderators":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"showOnProfile":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"slackChannel":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"slackChannelPrivate":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"slackInvite":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackSync":{"type":"object","properties":{"at":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"error":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["at","error"],"additionalProperties":false}},"required":["admission","canEdit","canInvite","canManageRoles","category","coverUrl","description","faces","id","invitationId","invitationPending","joined","knownMembers","memberCount","membersVisibility","moderators","name","owners","showOnProfile","slackChannel","slackChannelPrivate","slackInvite","slackSync"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"communities.list"}},"/manage/communities/members":{"post":{"operationId":"communities.members","summary":"List a community's members","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"}},"required":["communityId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"canModerate":{"type":"boolean"},"hiddenCount":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"canRemove":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"role":{"anyOf":[{"type":"null"},{"const":"moderator"},{"const":"owner"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["canRemove","id","name","photoUrl","role","slackUserId","title","userId"],"additionalProperties":false}},"pendingInvitations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["canModerate","hiddenCount","members","pendingInvitations","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"communities.members"}},"/manage/communities/ofPerson":{"post":{"operationId":"communities.ofPerson","summary":"List the communities a person belongs to","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"name":{"type":"string"},"showOnProfile":{"type":"boolean"},"slackChannelName":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["category","coverUrl","id","name","showOnProfile","slackChannelName"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"communities.ofPerson"}},"/manage/communities/removeMember":{"post":{"operationId":"communities.removeMember","summary":"Remove someone from a community, as its owner or moderator","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"personId":{"type":"string"},"confirm":{"const":"communities.removeMember"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"removed":{"type":"boolean"}},"required":["removed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.removeMember"}},"/manage/communities/revokeInvitation":{"post":{"operationId":"communities.revokeInvitation","summary":"Revoke a pending community invitation as its owner or administrator","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"personId":{"type":"string"},"confirm":{"const":"communities.revokeInvitation"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revoked":{"type":"boolean"}},"required":["revoked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.revokeInvitation"}},"/manage/communities/save":{"post":{"operationId":"communities.save","summary":"Create or edit a community, optionally tied to a Slack channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"admission":{"anyOf":[{"const":"invite_only"},{"const":"open"}]},"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"description":{"type":"string"},"id":{"type":"string"},"membersVisibility":{"anyOf":[{"const":"everyone"},{"const":"self_chosen"}]},"moderatorIds":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"ownerIds":{"type":"array","items":{"type":"string"}},"slackChannel":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"template":{"type":"object","properties":{"id":{"type":"string"},"picture":{"anyOf":[{"const":"none"},{"const":"other"},{"const":"template"}]}},"required":["id","picture"],"additionalProperties":false},"confirm":{"const":"communities.save"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["category","name","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.save"}},"/manage/communities/setVisibility":{"post":{"operationId":"communities.setVisibility","summary":"Show or hide a community on your profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"showOnProfile":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","showOnProfile","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.setVisibility"}},"/manage/communities/sync":{"post":{"operationId":"communities.sync","summary":"Sync a community's members with its Slack channel now","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.sync"}},"/manage/communities/uploadCover":{"post":{"operationId":"communities.uploadCover","summary":"Set a community cover from a PNG, JPEG or WebP picture sent as base64, as its owner, moderator or an administrator","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"string"},"image":{"type":"string"},"confirm":{"const":"communities.uploadCover"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["communityId","image","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["coverUrl"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"communities.uploadCover"}},"/manage/credentials/api/create":{"post":{"operationId":"credentials.api.create","summary":"Delegate a subset of this credential with bounded expiry and inherited revocation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acknowledgeExternalAccess":{"const":true},"name":{"type":"string"},"permissions":{"type":"array","items":{"anyOf":[{"const":"access.enableSlack"},{"const":"access.get"},{"const":"access.save"},{"const":"access.saveRole"},{"const":"access.slackWaiting"},{"const":"assistant.conversations"},{"const":"assistant.delete"},{"const":"assistant.history"},{"const":"assistant.send"},{"const":"assistant.stop"},{"const":"badges.award"},{"const":"badges.claim"},{"const":"badges.decideRequest"},{"const":"badges.generatePicture"},{"const":"badges.hideOwn"},{"const":"badges.holders"},{"const":"badges.list"},{"const":"badges.ofPerson"},{"const":"badges.request"},{"const":"badges.revoke"},{"const":"badges.save"},{"const":"badges.saveSettings"},{"const":"badges.setHidden"},{"const":"badges.settings"},{"const":"badges.uploadPicture"},{"const":"celebrations.card"},{"const":"celebrations.cards"},{"const":"celebrations.deliveries"},{"const":"celebrations.mine"},{"const":"celebrations.preferences"},{"const":"celebrations.preview"},{"const":"celebrations.program"},{"const":"celebrations.refresh"},{"const":"celebrations.removeCardNote"},{"const":"celebrations.review"},{"const":"celebrations.save"},{"const":"celebrations.savePreferences"},{"const":"celebrations.signCard"},{"const":"channels.list"},{"const":"commands.get"},{"const":"communities.archive"},{"const":"communities.channelSuggestions"},{"const":"communities.createCapabilities"},{"const":"communities.createSlackChannel"},{"const":"communities.fromChannels"},{"const":"communities.generateCover"},{"const":"communities.invite"},{"const":"communities.join"},{"const":"communities.leave"},{"const":"communities.list"},{"const":"communities.members"},{"const":"communities.ofPerson"},{"const":"communities.removeMember"},{"const":"communities.revokeInvitation"},{"const":"communities.save"},{"const":"communities.setVisibility"},{"const":"communities.sync"},{"const":"communities.uploadCover"},{"const":"credentials.api.create"},{"const":"credentials.api.list"},{"const":"credentials.api.revoke"},{"const":"digest.actOnNudge"},{"const":"digest.dismissNudge"},{"const":"digest.nudge"},{"const":"digest.nudges"},{"const":"digest.preview"},{"const":"digest.saveSettings"},{"const":"digest.settings"},{"const":"exports.team"},{"const":"getStarted.celebrate"},{"const":"getStarted.celebration"},{"const":"getStarted.dismiss"},{"const":"getStarted.draftIntro"},{"const":"getStarted.get"},{"const":"getStarted.intro"},{"const":"getStarted.wizard"},{"const":"home.feed"},{"const":"home.preferences"},{"const":"home.react"},{"const":"home.story"},{"const":"hr.categories"},{"const":"hr.command"},{"const":"hr.configure"},{"const":"hr.deliver"},{"const":"hr.get"},{"const":"hr.list"},{"const":"hr.readiness"},{"const":"hr.rebuildCategories"},{"const":"hr.renameTeam"},{"const":"hr.retryDelivery"},{"const":"hr.saveCategories"},{"const":"hr.settings"},{"const":"hr.share"},{"const":"hr.shareSources"},{"const":"identities.linkSlack"},{"const":"identities.linkWeb"},{"const":"identities.list"},{"const":"identities.slackAccounts"},{"const":"identities.unlink"},{"const":"identities.webAccounts"},{"const":"integrations.authorize"},{"const":"invitations.cancel"},{"const":"invitations.candidates"},{"const":"invitations.create"},{"const":"invitations.createMany"},{"const":"invitations.inviteDirectory"},{"const":"invitations.list"},{"const":"knowledge.connections.browse"},{"const":"knowledge.connections.connect"},{"const":"knowledge.connections.disconnect"},{"const":"knowledge.connections.list"},{"const":"knowledge.connections.request"},{"const":"knowledge.connections.requests"},{"const":"knowledge.context"},{"const":"knowledge.policies.coverage"},{"const":"knowledge.search"},{"const":"knowledge.sources.archive"},{"const":"knowledge.sources.changeAudience"},{"const":"knowledge.sources.get"},{"const":"knowledge.sources.history"},{"const":"knowledge.sources.importConnected"},{"const":"knowledge.sources.importWebsite"},{"const":"knowledge.sources.list"},{"const":"knowledge.sources.publish"},{"const":"knowledge.sources.refresh"},{"const":"knowledge.sources.restore"},{"const":"knowledge.sources.save"},{"const":"knowledge.sources.search"},{"const":"knowledge.sources.withdraw"},{"const":"knowledge.sources.write"},{"const":"knowledge.uploads.appendPart"},{"const":"knowledge.uploads.complete"},{"const":"knowledge.uploads.create"},{"const":"knowledge.uploads.get"},{"const":"knowledge.uploads.retry"},{"const":"manager.current"},{"const":"mcp.knowledge"},{"const":"network.claim"},{"const":"network.mine"},{"const":"network.ofPerson"},{"const":"network.orgChart"},{"const":"notifications.preferences"},{"const":"notifications.save"},{"const":"onboarding.answerBuddyAsk"},{"const":"onboarding.answerCheckIn"},{"const":"onboarding.answerFirstDaysCheckIn"},{"const":"onboarding.approve"},{"const":"onboarding.askBuddy"},{"const":"onboarding.assignBuddy"},{"const":"onboarding.buddySuggestions"},{"const":"onboarding.candidates"},{"const":"onboarding.enroll"},{"const":"onboarding.enrollmentPreview"},{"const":"onboarding.firstDaysCheckIns"},{"const":"onboarding.firstDaysResults"},{"const":"onboarding.mine"},{"const":"onboarding.person"},{"const":"onboarding.previewEnrollment"},{"const":"onboarding.program"},{"const":"onboarding.remove"},{"const":"onboarding.respondBuddy"},{"const":"onboarding.retry"},{"const":"onboarding.saveProgram"},{"const":"onboarding.update"},{"const":"operations.activity"},{"const":"operations.dispatchInbox"},{"const":"operations.reconcile"},{"const":"operations.status"},{"const":"permissions.list"},{"const":"praise.addChannel"},{"const":"praise.composer"},{"const":"praise.feed"},{"const":"praise.insights"},{"const":"praise.mine"},{"const":"praise.ofPerson"},{"const":"praise.removeChannel"},{"const":"praise.saveSettings"},{"const":"praise.send"},{"const":"praise.setDigest"},{"const":"praise.setHidden"},{"const":"praise.settings"},{"const":"profiles.cover.delete"},{"const":"profiles.draft"},{"const":"profiles.employeeNumber"},{"const":"profiles.get"},{"const":"profiles.photo.delete"},{"const":"profiles.positions.delete"},{"const":"profiles.positions.save"},{"const":"profiles.save"},{"const":"profiles.settings"},{"const":"profiles.whoKnows"},{"const":"programs.archive"},{"const":"programs.create"},{"const":"programs.get"},{"const":"programs.joinChannel"},{"const":"programs.list"},{"const":"programs.options"},{"const":"programs.pause"},{"const":"programs.people"},{"const":"programs.preview"},{"const":"programs.resume"},{"const":"programs.schedulePreview"},{"const":"programs.syncRoster"},{"const":"programs.update"},{"const":"pulse.actions"},{"const":"pulse.addQuestion"},{"const":"pulse.addTemplate"},{"const":"pulse.answer"},{"const":"pulse.asked"},{"const":"pulse.audienceOptions"},{"const":"pulse.createAction"},{"const":"pulse.decideProposal"},{"const":"pulse.editProposal"},{"const":"pulse.insights"},{"const":"pulse.latestRead"},{"const":"pulse.mine"},{"const":"pulse.program"},{"const":"pulse.proposals"},{"const":"pulse.proposeQuestions"},{"const":"pulse.questionDetail"},{"const":"pulse.questions"},{"const":"pulse.requestProposals"},{"const":"pulse.saveProgram"},{"const":"pulse.setQuestionAudience"},{"const":"pulse.setQuestionStatus"},{"const":"pulse.skip"},{"const":"pulse.today"},{"const":"pulse.updateAction"},{"const":"reminders.mine"},{"const":"reminders.saveMine"},{"const":"reminders.saveSetting"},{"const":"reminders.settings"},{"const":"reports.answerFeedback"},{"const":"reports.connections"},{"const":"reports.knowledge"},{"const":"reports.knowledgeSource"},{"const":"reports.melloTrial"},{"const":"reports.melloValue"},{"const":"reports.needsYou"},{"const":"reports.onboarding"},{"const":"reports.overview"},{"const":"reports.people"},{"const":"runs.details"},{"const":"runs.dispatch"},{"const":"runs.get"},{"const":"runs.history.get"},{"const":"runs.history.list"},{"const":"runs.list"},{"const":"runs.request"},{"const":"runs.retry"},{"const":"runs.stopKnownFailures"},{"const":"support.assign"},{"const":"support.close"},{"const":"support.create"},{"const":"support.get"},{"const":"support.list"},{"const":"support.reply"},{"const":"sync.connect"},{"const":"sync.current"},{"const":"sync.disconnect"},{"const":"sync.request"},{"const":"sync.run"},{"const":"team.answerMinutes"},{"const":"team.dismissLaunchPost"},{"const":"team.launchPost"},{"const":"teams.connectionPermissions"},{"const":"teams.current"},{"const":"teams.discardPairHistory"},{"const":"teams.initialize"},{"const":"teams.moveSlackChannels"},{"const":"teams.rename"},{"const":"teams.resendSlackWelcome"},{"const":"teams.saveAgentSetup"},{"const":"teams.saveSlackJoinAccess"},{"const":"teams.saveSlackProfileLink"},{"const":"teams.setup"},{"const":"teams.slackChannels"},{"const":"teams.slackJoinAccess"},{"const":"teams.slackProfileLink"},{"const":"teams.status"},{"const":"teams.syncSlackProfileLinks"},{"const":"teams.uploadPairHistory"},{"const":"timeOff.balances"},{"const":"units.archive"},{"const":"units.list"},{"const":"units.save"},{"const":"users.activity"},{"const":"users.assignManagers"},{"const":"users.blockPair"},{"const":"users.blockedPairs"},{"const":"users.details"},{"const":"users.filterOptions"},{"const":"users.get"},{"const":"users.list"},{"const":"users.managerHistory"},{"const":"users.managers"},{"const":"users.page"},{"const":"users.participants"},{"const":"users.participation"},{"const":"users.profile"},{"const":"users.proposeReportingLines"},{"const":"users.reportingLineProposal"},{"const":"users.reviewReportingLines"},{"const":"users.save"}]}},"confirm":{"const":"credentials.api.create"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["acknowledgeExternalAccess","name","permissions","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"baseUrl":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"token":{"type":"string"}},"required":["baseUrl","expiresAt","id","name","token"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"credentials.api.create"}},"/manage/credentials/api/list":{"post":{"operationId":"credentials.api.list","summary":"List the workspace's API keys and what each can do","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"baseUrl":{"type":"string"},"keys":{"type":"array","items":{"type":"object","properties":{"expiresAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"isActive":{"type":"boolean"},"lastUsedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"name":{"type":"string"},"permissions":{"type":"array","items":{"anyOf":[{"const":"access.enableSlack"},{"const":"access.get"},{"const":"access.save"},{"const":"access.saveRole"},{"const":"access.slackWaiting"},{"const":"assistant.conversations"},{"const":"assistant.delete"},{"const":"assistant.history"},{"const":"assistant.send"},{"const":"assistant.stop"},{"const":"badges.award"},{"const":"badges.claim"},{"const":"badges.decideRequest"},{"const":"badges.generatePicture"},{"const":"badges.hideOwn"},{"const":"badges.holders"},{"const":"badges.list"},{"const":"badges.ofPerson"},{"const":"badges.request"},{"const":"badges.revoke"},{"const":"badges.save"},{"const":"badges.saveSettings"},{"const":"badges.setHidden"},{"const":"badges.settings"},{"const":"badges.uploadPicture"},{"const":"celebrations.card"},{"const":"celebrations.cards"},{"const":"celebrations.deliveries"},{"const":"celebrations.mine"},{"const":"celebrations.preferences"},{"const":"celebrations.preview"},{"const":"celebrations.program"},{"const":"celebrations.refresh"},{"const":"celebrations.removeCardNote"},{"const":"celebrations.review"},{"const":"celebrations.save"},{"const":"celebrations.savePreferences"},{"const":"celebrations.signCard"},{"const":"channels.list"},{"const":"commands.get"},{"const":"communities.archive"},{"const":"communities.channelSuggestions"},{"const":"communities.createCapabilities"},{"const":"communities.createSlackChannel"},{"const":"communities.fromChannels"},{"const":"communities.generateCover"},{"const":"communities.invite"},{"const":"communities.join"},{"const":"communities.leave"},{"const":"communities.list"},{"const":"communities.members"},{"const":"communities.ofPerson"},{"const":"communities.removeMember"},{"const":"communities.revokeInvitation"},{"const":"communities.save"},{"const":"communities.setVisibility"},{"const":"communities.sync"},{"const":"communities.uploadCover"},{"const":"credentials.api.create"},{"const":"credentials.api.list"},{"const":"credentials.api.revoke"},{"const":"digest.actOnNudge"},{"const":"digest.dismissNudge"},{"const":"digest.nudge"},{"const":"digest.nudges"},{"const":"digest.preview"},{"const":"digest.saveSettings"},{"const":"digest.settings"},{"const":"exports.team"},{"const":"getStarted.celebrate"},{"const":"getStarted.celebration"},{"const":"getStarted.dismiss"},{"const":"getStarted.draftIntro"},{"const":"getStarted.get"},{"const":"getStarted.intro"},{"const":"getStarted.wizard"},{"const":"home.feed"},{"const":"home.preferences"},{"const":"home.react"},{"const":"home.story"},{"const":"hr.categories"},{"const":"hr.command"},{"const":"hr.configure"},{"const":"hr.deliver"},{"const":"hr.get"},{"const":"hr.list"},{"const":"hr.readiness"},{"const":"hr.rebuildCategories"},{"const":"hr.renameTeam"},{"const":"hr.retryDelivery"},{"const":"hr.saveCategories"},{"const":"hr.settings"},{"const":"hr.share"},{"const":"hr.shareSources"},{"const":"identities.linkSlack"},{"const":"identities.linkWeb"},{"const":"identities.list"},{"const":"identities.slackAccounts"},{"const":"identities.unlink"},{"const":"identities.webAccounts"},{"const":"integrations.authorize"},{"const":"invitations.cancel"},{"const":"invitations.candidates"},{"const":"invitations.create"},{"const":"invitations.createMany"},{"const":"invitations.inviteDirectory"},{"const":"invitations.list"},{"const":"knowledge.connections.browse"},{"const":"knowledge.connections.connect"},{"const":"knowledge.connections.disconnect"},{"const":"knowledge.connections.list"},{"const":"knowledge.connections.request"},{"const":"knowledge.connections.requests"},{"const":"knowledge.context"},{"const":"knowledge.policies.coverage"},{"const":"knowledge.search"},{"const":"knowledge.sources.archive"},{"const":"knowledge.sources.changeAudience"},{"const":"knowledge.sources.get"},{"const":"knowledge.sources.history"},{"const":"knowledge.sources.importConnected"},{"const":"knowledge.sources.importWebsite"},{"const":"knowledge.sources.list"},{"const":"knowledge.sources.publish"},{"const":"knowledge.sources.refresh"},{"const":"knowledge.sources.restore"},{"const":"knowledge.sources.save"},{"const":"knowledge.sources.search"},{"const":"knowledge.sources.withdraw"},{"const":"knowledge.sources.write"},{"const":"knowledge.uploads.appendPart"},{"const":"knowledge.uploads.complete"},{"const":"knowledge.uploads.create"},{"const":"knowledge.uploads.get"},{"const":"knowledge.uploads.retry"},{"const":"manager.current"},{"const":"mcp.knowledge"},{"const":"network.claim"},{"const":"network.mine"},{"const":"network.ofPerson"},{"const":"network.orgChart"},{"const":"notifications.preferences"},{"const":"notifications.save"},{"const":"onboarding.answerBuddyAsk"},{"const":"onboarding.answerCheckIn"},{"const":"onboarding.answerFirstDaysCheckIn"},{"const":"onboarding.approve"},{"const":"onboarding.askBuddy"},{"const":"onboarding.assignBuddy"},{"const":"onboarding.buddySuggestions"},{"const":"onboarding.candidates"},{"const":"onboarding.enroll"},{"const":"onboarding.enrollmentPreview"},{"const":"onboarding.firstDaysCheckIns"},{"const":"onboarding.firstDaysResults"},{"const":"onboarding.mine"},{"const":"onboarding.person"},{"const":"onboarding.previewEnrollment"},{"const":"onboarding.program"},{"const":"onboarding.remove"},{"const":"onboarding.respondBuddy"},{"const":"onboarding.retry"},{"const":"onboarding.saveProgram"},{"const":"onboarding.update"},{"const":"operations.activity"},{"const":"operations.dispatchInbox"},{"const":"operations.reconcile"},{"const":"operations.status"},{"const":"permissions.list"},{"const":"praise.addChannel"},{"const":"praise.composer"},{"const":"praise.feed"},{"const":"praise.insights"},{"const":"praise.mine"},{"const":"praise.ofPerson"},{"const":"praise.removeChannel"},{"const":"praise.saveSettings"},{"const":"praise.send"},{"const":"praise.setDigest"},{"const":"praise.setHidden"},{"const":"praise.settings"},{"const":"profiles.cover.delete"},{"const":"profiles.draft"},{"const":"profiles.employeeNumber"},{"const":"profiles.get"},{"const":"profiles.photo.delete"},{"const":"profiles.positions.delete"},{"const":"profiles.positions.save"},{"const":"profiles.save"},{"const":"profiles.settings"},{"const":"profiles.whoKnows"},{"const":"programs.archive"},{"const":"programs.create"},{"const":"programs.get"},{"const":"programs.joinChannel"},{"const":"programs.list"},{"const":"programs.options"},{"const":"programs.pause"},{"const":"programs.people"},{"const":"programs.preview"},{"const":"programs.resume"},{"const":"programs.schedulePreview"},{"const":"programs.syncRoster"},{"const":"programs.update"},{"const":"pulse.actions"},{"const":"pulse.addQuestion"},{"const":"pulse.addTemplate"},{"const":"pulse.answer"},{"const":"pulse.asked"},{"const":"pulse.audienceOptions"},{"const":"pulse.createAction"},{"const":"pulse.decideProposal"},{"const":"pulse.editProposal"},{"const":"pulse.insights"},{"const":"pulse.latestRead"},{"const":"pulse.mine"},{"const":"pulse.program"},{"const":"pulse.proposals"},{"const":"pulse.proposeQuestions"},{"const":"pulse.questionDetail"},{"const":"pulse.questions"},{"const":"pulse.requestProposals"},{"const":"pulse.saveProgram"},{"const":"pulse.setQuestionAudience"},{"const":"pulse.setQuestionStatus"},{"const":"pulse.skip"},{"const":"pulse.today"},{"const":"pulse.updateAction"},{"const":"reminders.mine"},{"const":"reminders.saveMine"},{"const":"reminders.saveSetting"},{"const":"reminders.settings"},{"const":"reports.answerFeedback"},{"const":"reports.connections"},{"const":"reports.knowledge"},{"const":"reports.knowledgeSource"},{"const":"reports.melloTrial"},{"const":"reports.melloValue"},{"const":"reports.needsYou"},{"const":"reports.onboarding"},{"const":"reports.overview"},{"const":"reports.people"},{"const":"runs.details"},{"const":"runs.dispatch"},{"const":"runs.get"},{"const":"runs.history.get"},{"const":"runs.history.list"},{"const":"runs.list"},{"const":"runs.request"},{"const":"runs.retry"},{"const":"runs.stopKnownFailures"},{"const":"support.assign"},{"const":"support.close"},{"const":"support.create"},{"const":"support.get"},{"const":"support.list"},{"const":"support.reply"},{"const":"sync.connect"},{"const":"sync.current"},{"const":"sync.disconnect"},{"const":"sync.request"},{"const":"sync.run"},{"const":"team.answerMinutes"},{"const":"team.dismissLaunchPost"},{"const":"team.launchPost"},{"const":"teams.connectionPermissions"},{"const":"teams.current"},{"const":"teams.discardPairHistory"},{"const":"teams.initialize"},{"const":"teams.moveSlackChannels"},{"const":"teams.rename"},{"const":"teams.resendSlackWelcome"},{"const":"teams.saveAgentSetup"},{"const":"teams.saveSlackJoinAccess"},{"const":"teams.saveSlackProfileLink"},{"const":"teams.setup"},{"const":"teams.slackChannels"},{"const":"teams.slackJoinAccess"},{"const":"teams.slackProfileLink"},{"const":"teams.status"},{"const":"teams.syncSlackProfileLinks"},{"const":"teams.uploadPairHistory"},{"const":"timeOff.balances"},{"const":"units.archive"},{"const":"units.list"},{"const":"units.save"},{"const":"users.activity"},{"const":"users.assignManagers"},{"const":"users.blockPair"},{"const":"users.blockedPairs"},{"const":"users.details"},{"const":"users.filterOptions"},{"const":"users.get"},{"const":"users.list"},{"const":"users.managerHistory"},{"const":"users.managers"},{"const":"users.page"},{"const":"users.participants"},{"const":"users.participation"},{"const":"users.profile"},{"const":"users.proposeReportingLines"},{"const":"users.reportingLineProposal"},{"const":"users.reviewReportingLines"},{"const":"users.save"}]}},"scopes":{"type":"array","items":{"anyOf":[{"const":"access:read"},{"const":"access:write"},{"const":"assistant:read"},{"const":"assistant:write"},{"const":"celebrations:read"},{"const":"celebrations:write"},{"const":"credentials:read"},{"const":"credentials:write"},{"const":"exports:read"},{"const":"hr:read"},{"const":"hr:write"},{"const":"identities:read"},{"const":"identities:write"},{"const":"integrations:read"},{"const":"integrations:write"},{"const":"knowledge:manage"},{"const":"knowledge:read"},{"const":"knowledge:write"},{"const":"manager:read"},{"const":"onboarding:read"},{"const":"onboarding:write"},{"const":"operations:read"},{"const":"operations:write"},{"const":"operator:read"},{"const":"operator:write"},{"const":"participation:write"},{"const":"praise:read"},{"const":"praise:write"},{"const":"profile:write"},{"const":"programs:read"},{"const":"programs:write"},{"const":"pulse:read"},{"const":"pulse:write"},{"const":"reports:read"},{"const":"runs:read"},{"const":"runs:write"},{"const":"self:read"},{"const":"self:write"},{"const":"support:read"},{"const":"support:write"},{"const":"team:read"},{"const":"team:write"},{"const":"users:read"},{"const":"users:write"}]}}},"required":["expiresAt","id","isActive","lastUsedAt","name","permissions","scopes"],"additionalProperties":false}},"permissionCatalog":{"type":"array","items":{"type":"object","properties":{"access":{"anyOf":[{"const":"read"},{"const":"write"}]},"alwaysAllowed":{"type":"boolean"},"description":{"type":"string"},"grantable":{"type":"boolean"},"granted":{"type":"boolean"},"id":{"anyOf":[{"const":"access.enableSlack"},{"const":"access.get"},{"const":"access.save"},{"const":"access.saveRole"},{"const":"access.slackWaiting"},{"const":"assistant.conversations"},{"const":"assistant.delete"},{"const":"assistant.history"},{"const":"assistant.send"},{"const":"assistant.stop"},{"const":"badges.award"},{"const":"badges.claim"},{"const":"badges.decideRequest"},{"const":"badges.generatePicture"},{"const":"badges.hideOwn"},{"const":"badges.holders"},{"const":"badges.list"},{"const":"badges.ofPerson"},{"const":"badges.request"},{"const":"badges.revoke"},{"const":"badges.save"},{"const":"badges.saveSettings"},{"const":"badges.setHidden"},{"const":"badges.settings"},{"const":"badges.uploadPicture"},{"const":"celebrations.card"},{"const":"celebrations.cards"},{"const":"celebrations.deliveries"},{"const":"celebrations.mine"},{"const":"celebrations.preferences"},{"const":"celebrations.preview"},{"const":"celebrations.program"},{"const":"celebrations.refresh"},{"const":"celebrations.removeCardNote"},{"const":"celebrations.review"},{"const":"celebrations.save"},{"const":"celebrations.savePreferences"},{"const":"celebrations.signCard"},{"const":"channels.list"},{"const":"commands.get"},{"const":"communities.archive"},{"const":"communities.channelSuggestions"},{"const":"communities.createCapabilities"},{"const":"communities.createSlackChannel"},{"const":"communities.fromChannels"},{"const":"communities.generateCover"},{"const":"communities.invite"},{"const":"communities.join"},{"const":"communities.leave"},{"const":"communities.list"},{"const":"communities.members"},{"const":"communities.ofPerson"},{"const":"communities.removeMember"},{"const":"communities.revokeInvitation"},{"const":"communities.save"},{"const":"communities.setVisibility"},{"const":"communities.sync"},{"const":"communities.uploadCover"},{"const":"credentials.api.create"},{"const":"credentials.api.list"},{"const":"credentials.api.revoke"},{"const":"digest.actOnNudge"},{"const":"digest.dismissNudge"},{"const":"digest.nudge"},{"const":"digest.nudges"},{"const":"digest.preview"},{"const":"digest.saveSettings"},{"const":"digest.settings"},{"const":"exports.team"},{"const":"getStarted.celebrate"},{"const":"getStarted.celebration"},{"const":"getStarted.dismiss"},{"const":"getStarted.draftIntro"},{"const":"getStarted.get"},{"const":"getStarted.intro"},{"const":"getStarted.wizard"},{"const":"home.feed"},{"const":"home.preferences"},{"const":"home.react"},{"const":"home.story"},{"const":"hr.categories"},{"const":"hr.command"},{"const":"hr.configure"},{"const":"hr.deliver"},{"const":"hr.get"},{"const":"hr.list"},{"const":"hr.readiness"},{"const":"hr.rebuildCategories"},{"const":"hr.renameTeam"},{"const":"hr.retryDelivery"},{"const":"hr.saveCategories"},{"const":"hr.settings"},{"const":"hr.share"},{"const":"hr.shareSources"},{"const":"identities.linkSlack"},{"const":"identities.linkWeb"},{"const":"identities.list"},{"const":"identities.slackAccounts"},{"const":"identities.unlink"},{"const":"identities.webAccounts"},{"const":"integrations.authorize"},{"const":"invitations.cancel"},{"const":"invitations.candidates"},{"const":"invitations.create"},{"const":"invitations.createMany"},{"const":"invitations.inviteDirectory"},{"const":"invitations.list"},{"const":"knowledge.connections.browse"},{"const":"knowledge.connections.connect"},{"const":"knowledge.connections.disconnect"},{"const":"knowledge.connections.list"},{"const":"knowledge.connections.request"},{"const":"knowledge.connections.requests"},{"const":"knowledge.context"},{"const":"knowledge.policies.coverage"},{"const":"knowledge.search"},{"const":"knowledge.sources.archive"},{"const":"knowledge.sources.changeAudience"},{"const":"knowledge.sources.get"},{"const":"knowledge.sources.history"},{"const":"knowledge.sources.importConnected"},{"const":"knowledge.sources.importWebsite"},{"const":"knowledge.sources.list"},{"const":"knowledge.sources.publish"},{"const":"knowledge.sources.refresh"},{"const":"knowledge.sources.restore"},{"const":"knowledge.sources.save"},{"const":"knowledge.sources.search"},{"const":"knowledge.sources.withdraw"},{"const":"knowledge.sources.write"},{"const":"knowledge.uploads.appendPart"},{"const":"knowledge.uploads.complete"},{"const":"knowledge.uploads.create"},{"const":"knowledge.uploads.get"},{"const":"knowledge.uploads.retry"},{"const":"manager.current"},{"const":"mcp.knowledge"},{"const":"network.claim"},{"const":"network.mine"},{"const":"network.ofPerson"},{"const":"network.orgChart"},{"const":"notifications.preferences"},{"const":"notifications.save"},{"const":"onboarding.answerBuddyAsk"},{"const":"onboarding.answerCheckIn"},{"const":"onboarding.answerFirstDaysCheckIn"},{"const":"onboarding.approve"},{"const":"onboarding.askBuddy"},{"const":"onboarding.assignBuddy"},{"const":"onboarding.buddySuggestions"},{"const":"onboarding.candidates"},{"const":"onboarding.enroll"},{"const":"onboarding.enrollmentPreview"},{"const":"onboarding.firstDaysCheckIns"},{"const":"onboarding.firstDaysResults"},{"const":"onboarding.mine"},{"const":"onboarding.person"},{"const":"onboarding.previewEnrollment"},{"const":"onboarding.program"},{"const":"onboarding.remove"},{"const":"onboarding.respondBuddy"},{"const":"onboarding.retry"},{"const":"onboarding.saveProgram"},{"const":"onboarding.update"},{"const":"operations.activity"},{"const":"operations.dispatchInbox"},{"const":"operations.reconcile"},{"const":"operations.status"},{"const":"permissions.list"},{"const":"praise.addChannel"},{"const":"praise.composer"},{"const":"praise.feed"},{"const":"praise.insights"},{"const":"praise.mine"},{"const":"praise.ofPerson"},{"const":"praise.removeChannel"},{"const":"praise.saveSettings"},{"const":"praise.send"},{"const":"praise.setDigest"},{"const":"praise.setHidden"},{"const":"praise.settings"},{"const":"profiles.cover.delete"},{"const":"profiles.draft"},{"const":"profiles.employeeNumber"},{"const":"profiles.get"},{"const":"profiles.photo.delete"},{"const":"profiles.positions.delete"},{"const":"profiles.positions.save"},{"const":"profiles.save"},{"const":"profiles.settings"},{"const":"profiles.whoKnows"},{"const":"programs.archive"},{"const":"programs.create"},{"const":"programs.get"},{"const":"programs.joinChannel"},{"const":"programs.list"},{"const":"programs.options"},{"const":"programs.pause"},{"const":"programs.people"},{"const":"programs.preview"},{"const":"programs.resume"},{"const":"programs.schedulePreview"},{"const":"programs.syncRoster"},{"const":"programs.update"},{"const":"pulse.actions"},{"const":"pulse.addQuestion"},{"const":"pulse.addTemplate"},{"const":"pulse.answer"},{"const":"pulse.asked"},{"const":"pulse.audienceOptions"},{"const":"pulse.createAction"},{"const":"pulse.decideProposal"},{"const":"pulse.editProposal"},{"const":"pulse.insights"},{"const":"pulse.latestRead"},{"const":"pulse.mine"},{"const":"pulse.program"},{"const":"pulse.proposals"},{"const":"pulse.proposeQuestions"},{"const":"pulse.questionDetail"},{"const":"pulse.questions"},{"const":"pulse.requestProposals"},{"const":"pulse.saveProgram"},{"const":"pulse.setQuestionAudience"},{"const":"pulse.setQuestionStatus"},{"const":"pulse.skip"},{"const":"pulse.today"},{"const":"pulse.updateAction"},{"const":"reminders.mine"},{"const":"reminders.saveMine"},{"const":"reminders.saveSetting"},{"const":"reminders.settings"},{"const":"reports.answerFeedback"},{"const":"reports.connections"},{"const":"reports.knowledge"},{"const":"reports.knowledgeSource"},{"const":"reports.melloTrial"},{"const":"reports.melloValue"},{"const":"reports.needsYou"},{"const":"reports.onboarding"},{"const":"reports.overview"},{"const":"reports.people"},{"const":"runs.details"},{"const":"runs.dispatch"},{"const":"runs.get"},{"const":"runs.history.get"},{"const":"runs.history.list"},{"const":"runs.list"},{"const":"runs.request"},{"const":"runs.retry"},{"const":"runs.stopKnownFailures"},{"const":"support.assign"},{"const":"support.close"},{"const":"support.create"},{"const":"support.get"},{"const":"support.list"},{"const":"support.reply"},{"const":"sync.connect"},{"const":"sync.current"},{"const":"sync.disconnect"},{"const":"sync.request"},{"const":"sync.run"},{"const":"team.answerMinutes"},{"const":"team.dismissLaunchPost"},{"const":"team.launchPost"},{"const":"teams.connectionPermissions"},{"const":"teams.current"},{"const":"teams.discardPairHistory"},{"const":"teams.initialize"},{"const":"teams.moveSlackChannels"},{"const":"teams.rename"},{"const":"teams.resendSlackWelcome"},{"const":"teams.saveAgentSetup"},{"const":"teams.saveSlackJoinAccess"},{"const":"teams.saveSlackProfileLink"},{"const":"teams.setup"},{"const":"teams.slackChannels"},{"const":"teams.slackJoinAccess"},{"const":"teams.slackProfileLink"},{"const":"teams.status"},{"const":"teams.syncSlackProfileLinks"},{"const":"teams.uploadPairHistory"},{"const":"timeOff.balances"},{"const":"units.archive"},{"const":"units.list"},{"const":"units.save"},{"const":"users.activity"},{"const":"users.assignManagers"},{"const":"users.blockPair"},{"const":"users.blockedPairs"},{"const":"users.details"},{"const":"users.filterOptions"},{"const":"users.get"},{"const":"users.list"},{"const":"users.managerHistory"},{"const":"users.managers"},{"const":"users.page"},{"const":"users.participants"},{"const":"users.participation"},{"const":"users.profile"},{"const":"users.proposeReportingLines"},{"const":"users.reportingLineProposal"},{"const":"users.reviewReportingLines"},{"const":"users.save"}]},"resource":{"type":"string"},"scope":{"anyOf":[{"type":"null"},{"const":"access:read"},{"const":"access:write"},{"const":"assistant:read"},{"const":"assistant:write"},{"const":"celebrations:read"},{"const":"celebrations:write"},{"const":"credentials:read"},{"const":"credentials:write"},{"const":"exports:read"},{"const":"hr:read"},{"const":"hr:write"},{"const":"identities:read"},{"const":"identities:write"},{"const":"integrations:read"},{"const":"integrations:write"},{"const":"knowledge:manage"},{"const":"knowledge:read"},{"const":"knowledge:write"},{"const":"manager:read"},{"const":"onboarding:read"},{"const":"onboarding:write"},{"const":"operations:read"},{"const":"operations:write"},{"const":"operator:read"},{"const":"operator:write"},{"const":"participation:write"},{"const":"praise:read"},{"const":"praise:write"},{"const":"profile:write"},{"const":"programs:read"},{"const":"programs:write"},{"const":"pulse:read"},{"const":"pulse:write"},{"const":"reports:read"},{"const":"runs:read"},{"const":"runs:write"},{"const":"self:read"},{"const":"self:write"},{"const":"support:read"},{"const":"support:write"},{"const":"team:read"},{"const":"team:write"},{"const":"users:read"},{"const":"users:write"}]}},"required":["access","alwaysAllowed","description","grantable","granted","id","resource","scope"],"additionalProperties":false}}},"required":["baseUrl","keys","permissionCatalog"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"credentials.api.list"}},"/manage/credentials/api/revoke":{"post":{"operationId":"credentials.api.revoke","summary":"Revoke an API key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["id","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revoked":{"type":"boolean"}},"required":["revoked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"credentials.api.revoke"}},"/manage/digest/actOnNudge":{"post":{"operationId":"digest.actOnNudge","summary":"Record that a culture nudge was acted on and get where its action goes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"anyOf":[{"const":"email"},{"const":"page"},{"const":"preview"},{"const":"slack"},{"const":"today"}]},"nudgeId":{"type":"string"},"confirm":{"const":"digest.actOnNudge"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["from","nudgeId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"dismissed":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"buddy_gap"},{"const":"cross_team"},{"const":"praise_gap"}]},"recorded":{"type":"boolean"},"title":{"type":"string"}},"required":["action","dismissed","id","kind","recorded","title"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"digest.actOnNudge"}},"/manage/digest/dismissNudge":{"post":{"operationId":"digest.dismissNudge","summary":"Dismiss a culture nudge for 90 days","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"anyOf":[{"const":"email"},{"const":"page"},{"const":"preview"},{"const":"slack"},{"const":"today"}]},"nudgeId":{"type":"string"},"confirm":{"const":"digest.dismissNudge"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["from","nudgeId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"dismissed":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"buddy_gap"},{"const":"cross_team"},{"const":"praise_gap"}]},"recorded":{"type":"boolean"},"title":{"type":"string"}},"required":["action","dismissed","id","kind","recorded","title"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"digest.dismissNudge"}},"/manage/digest/nudge":{"post":{"operationId":"digest.nudge","summary":"Read one of Mello’s culture nudges","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"nudgeId":{"type":"string"}},"required":["nudgeId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"dismissed":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"buddy_gap"},{"const":"cross_team"},{"const":"praise_gap"}]},"title":{"type":"string"}},"required":["action","dismissed","id","kind","title"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"digest.nudge"}},"/manage/digest/nudges":{"post":{"operationId":"digest.nudges","summary":"List Mello’s culture nudges for the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"department":{"type":"string"},"id":{"type":"string"},"kind":{"const":"praise_gap"},"people":{"type":"number"},"subject":{"type":"string"},"title":{"type":"string"},"weeks":{"type":"number"}},"required":["action","department","id","kind","people","subject","title","weeks"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"days":{"type":"number"},"enrollmentId":{"type":"string"},"hires":{"type":"number"},"id":{"type":"string"},"kind":{"const":"buddy_gap"},"programId":{"type":"string"},"subject":{"type":"string"},"title":{"type":"string"}},"required":["action","days","enrollmentId","hires","id","kind","programId","subject","title"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"departments":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"kind":{"const":"cross_team"},"programId":{"anyOf":[{"type":"null"},{"type":"string"}]},"subject":{"type":"string"},"title":{"type":"string"},"weeks":{"type":"number"}},"required":["action","departments","id","kind","programId","subject","title","weeks"],"additionalProperties":false}]}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"digest.nudges"}},"/manage/digest/preview":{"post":{"operationId":"digest.preview","summary":"Preview the HR digest for the last period","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"anyOf":[{"type":"null"},{"type":"object","properties":{"kind":{"anyOf":[{"const":"buddy"},{"const":"drafts"},{"const":"hr_waiting"},{"const":"need_help"},{"const":"no_source"},{"const":"recheck"}]},"label":{"type":"string"},"path":{"type":"string"}},"required":["kind","label","path"],"additionalProperties":false}]},"heading":{"type":"string"},"nudges":{"type":"array","items":{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"id":{"type":"string"},"kind":{"anyOf":[{"const":"buddy_gap"},{"const":"cross_team"},{"const":"praise_gap"}]},"title":{"type":"string"}},"required":["action","id","kind","title"],"additionalProperties":false}},"quiet":{"type":"boolean"},"range":{"type":"string"},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"const":"celebrations"},{"const":"connections"},{"const":"mello"},{"const":"needs_you"},{"const":"onboarding"},{"const":"praise"},{"const":"pulse"},{"const":"requests"}]},"link":{"type":"object","properties":{"label":{"type":"string"},"path":{"type":"string"}},"required":["label","path"],"additionalProperties":false},"note":{"type":"string"},"stats":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"],"additionalProperties":false}},"title":{"type":"string"}},"required":["id","link","stats","title"],"additionalProperties":false}},"subject":{"type":"string"},"summary":{"type":"string"},"tip":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"anyOf":[{"const":"badges"},{"const":"buddy"},{"const":"celebrations"},{"const":"communities"},{"const":"connections"},{"const":"first_week"},{"const":"guidance"},{"const":"invite"},{"const":"meet"},{"const":"my_reports"},{"const":"my_team"},{"const":"onboarding"},{"const":"org_team"},{"const":"praise_received"},{"const":"praise_values"},{"const":"profile"},{"const":"pulse"},{"const":"pulse_results"},{"const":"start_community"},{"const":"time_off"}]},"message":{"type":"string"},"path":{"type":"string"}},"required":["id","message","path"],"additionalProperties":false}]}},"required":["action","heading","nudges","quiet","range","sections","subject","summary","tip"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"digest.preview"}},"/manage/digest/saveSettings":{"post":{"operationId":"digest.saveSettings","summary":"Save the HR digest schedule and admin channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cadence":{"anyOf":[{"const":"biweekly"},{"const":"monthly"},{"const":"off"},{"const":"weekly"}]},"expectedRevision":{"type":"number"},"hour":{"type":"number"},"quiet":{"anyOf":[{"const":"short"},{"const":"skip"}]},"slackChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"type":"string"},"weekday":{"type":"number"},"confirm":{"const":"digest.saveSettings"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["cadence","expectedRevision","hour","quiet","slackChannelId","timezone","weekday","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"next":{"anyOf":[{"type":"null"},{"type":"object","properties":{"at":{"type":"string"},"periodEnd":{"type":"string"},"periodStart":{"type":"string"}},"required":["at","periodEnd","periodStart"],"additionalProperties":false}]},"revision":{"type":"number"},"saved":{"type":"boolean"},"settings":{"type":"object","properties":{"cadence":{"anyOf":[{"const":"biweekly"},{"const":"monthly"},{"const":"off"},{"const":"weekly"}]},"hour":{"type":"number"},"quiet":{"anyOf":[{"const":"short"},{"const":"skip"}]},"slackChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackChannelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["cadence","hour","quiet","slackChannelId","slackChannelName","timezone","weekday"],"additionalProperties":false}},"required":["next","revision","saved","settings"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"digest.saveSettings"}},"/manage/digest/settings":{"post":{"operationId":"digest.settings","summary":"Read the HR digest schedule","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"next":{"anyOf":[{"type":"null"},{"type":"object","properties":{"at":{"type":"string"},"periodEnd":{"type":"string"},"periodStart":{"type":"string"}},"required":["at","periodEnd","periodStart"],"additionalProperties":false}]},"revision":{"type":"number"},"saved":{"type":"boolean"},"settings":{"type":"object","properties":{"cadence":{"anyOf":[{"const":"biweekly"},{"const":"monthly"},{"const":"off"},{"const":"weekly"}]},"hour":{"type":"number"},"quiet":{"anyOf":[{"const":"short"},{"const":"skip"}]},"slackChannelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackChannelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["cadence","hour","quiet","slackChannelId","slackChannelName","timezone","weekday"],"additionalProperties":false}},"required":["next","revision","saved","settings"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"digest.settings"}},"/manage/exports/team":{"post":{"operationId":"exports.team","summary":"Export the workspace's programs, people and introduction history","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accessHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"billingMembers":{"type":"array","items":{"type":"object","properties":{"assignedAt":{"type":"string","format":"date-time"},"memberId":{"type":"string"},"periodId":{"type":"string"},"source":{"anyOf":[{"const":"legacy"},{"const":"shuffl"}]},"teamId":{"type":"string"}},"required":["assignedAt","memberId","periodId","source","teamId"],"additionalProperties":false}},"billingPeriods":{"type":"array","items":{"type":"object","properties":{"apiVersion":{"anyOf":[{"type":"null"},{"type":"string"}]},"currency":{"type":"string"},"customerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"end":{"type":"string","format":"date-time"},"finalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"included":{"type":"number"},"interval":{"anyOf":[{"const":"annual"},{"const":"monthly"}]},"policyVersion":{"type":"string"},"providerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"start":{"type":"string","format":"date-time"},"subscriptionItemId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"unitAmount":{"type":"number"}},"required":["apiVersion","currency","customerId","end","finalizedAt","id","included","interval","policyVersion","providerId","start","subscriptionItemId","teamId","unitAmount"],"additionalProperties":false}},"enrollments":{"type":"array","items":{"type":"object","properties":{"breakUntil":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"consentRevision":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"memberId":{"type":"string"},"optedIn":{"type":"boolean"},"present":{"type":"boolean"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["breakUntil","consentRevision","createdAt","memberId","optedIn","present","programId","reason","teamId","updatedAt"],"additionalProperties":false}},"exportedAt":{"type":"string"},"format":{"type":"string"},"groupMembers":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string"},"memberId":{"type":"string"},"runId":{"type":"string"},"teamId":{"type":"string"}},"required":["groupId","memberId","runId","teamId"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"canceledAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"deliveredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"ordinal":{"type":"number"},"runId":{"type":"string"},"teamId":{"type":"string"}},"required":["canceledAt","channelId","deliveredAt","id","ordinal","runId","teamId"],"additionalProperties":false}},"legacyBillingHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"legacyEnrollmentHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"legacyMatchingHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"legacyMonthlyHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"legacyRunHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"legacySlackAssociationHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"managerHistory":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","createdAt","details","entityId","id","teamId"],"additionalProperties":false}},"organizationUnits":{"type":"array","items":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"createdAt":{"type":"string","format":"date-time"},"hrTeam":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"},"revision":{"type":"number"},"teamId":{"type":"string"}},"required":["archivedAt","createdAt","hrTeam","id","kind","name","revision","teamId"],"additionalProperties":false}},"pairs":{"type":"array","items":{"type":"object","properties":{"blocked":{"type":"boolean"},"memberA":{"type":"string"},"memberB":{"type":"string"},"teamId":{"type":"string"},"weight":{"type":"number"}},"required":["blocked","memberA","memberB","teamId","weight"],"additionalProperties":false}},"participants":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false}},"personAccess":{"type":"array","items":{"type":"object","properties":{"employment":{"anyOf":[{"const":"employed"},{"const":"ended"},{"const":"on_leave"},{"const":"unknown"}]},"personId":{"type":"string"},"provisioningActive":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"revision":{"type":"number"},"status":{"anyOf":[{"const":"enabled"},{"const":"pending"},{"const":"suspended"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["employment","personId","provisioningActive","revision","status","teamId","updatedAt"],"additionalProperties":false}},"personDirectory":{"type":"array","items":{"type":"object","properties":{"employmentType":{"anyOf":[{"type":"null"},{"const":"contractor"},{"const":"full_time"},{"const":"intern"},{"const":"part_time"},{"const":"temporary"}]},"jobTitle":{"anyOf":[{"type":"null"},{"type":"string"}]},"managedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"managedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"memberId":{"type":"string"},"revision":{"type":"number"},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["employmentType","jobTitle","managedAt","managedBy","managerId","memberId","revision","startDate","teamId","timezone","updatedAt"],"additionalProperties":false}},"personIdentities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"issuer":{"type":"string"},"personId":{"type":"string"},"provider":{"type":"string"},"revision":{"type":"number"},"revokedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"verification":{"type":"string"},"verifiedAt":{"type":"string","format":"date-time"},"verifiedBy":{"type":"string"}},"required":["id","issuer","personId","provider","revision","revokedAt","subject","teamId","verification","verifiedAt","verifiedBy"],"additionalProperties":false}},"programs":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string"},"kind":{"anyOf":[{"const":"introductions"},{"const":"onboarding"}]},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"anyOf":[{"const":"cross-unit"},{"const":"group-frequency-weighted"},{"const":"group-frequency-weighted-v2"},{"const":"hosted"},{"const":"new-connections"},{"const":"random"},{"const":"unit-lottery-weighted"},{"const":"unit-weighted"},{"const":"unit-weighted-multiple-hosts-per-group"},{"const":"unit-weighted-one-host-per-group"},{"const":"within-unit"}]},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"matchingReviewRequired":{"type":"boolean"},"name":{"type":"string"},"nextRunAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"onboarding":{"anyOf":[{"type":"null"},{"type":"object","properties":{"buddyInvitation":{"type":"string"},"buddyOffsetDays":{"type":"number"},"checkIn":{"type":"string"},"checkInOffsetDays":{"type":"number"},"introductionOffsetDays":{"type":"number"},"responderPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendTime":{"type":"string"},"timezone":{"type":"string"}},"required":["buddyInvitation","buddyOffsetDays","checkIn","checkInOffsetDays","introductionOffsetDays","responderPersonId","sendTime","timezone"],"additionalProperties":false}]},"revision":{"type":"number"},"rosterSyncedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string"},"frequency":{"anyOf":[{"const":"days"},{"const":"hours"},{"const":"minutes"},{"const":"monthly-date"},{"const":"monthly-last-weekday"},{"const":"monthly-weekday"},{"const":"weeks"}]},"interval":{"type":"number"},"timezone":{"type":"string"}},"required":["anchor","frequency","interval","timezone"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"type":"string"},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"source-pending"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","timezone","version"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"anyOf":[{"type":"null"},{"type":"string"}]},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"operator-future-start"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","origin","timezone","version"],"additionalProperties":false}]},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"}]},"teamId":{"type":"string"}},"required":["channelId","channelName","createdAt","id","includeBios","includeSchedulingLink","intro","kind","match","matchingReviewRequired","name","nextRunAt","onboarding","revision","rosterSyncedAt","schedule","status","teamId"],"additionalProperties":false}},"runMembers":{"type":"array","items":{"type":"object","properties":{"consentRevision":{"type":"number"},"memberId":{"type":"string"},"runId":{"type":"string"},"selected":{"type":"boolean"},"teamId":{"type":"string"}},"required":["consentRevision","memberId","runId","selected","teamId"],"additionalProperties":false}},"runs":{"type":"array","items":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false}},"team":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"policy":{"type":"object","properties":{"maxParticipants":{"anyOf":[{"type":"null"},{"type":"number"}]},"maxPrograms":{"anyOf":[{"type":"null"},{"type":"number"}]},"name":{"anyOf":[{"const":"community"},{"const":"grandfathered"},{"const":"per-seat"},{"const":"pro"}]},"version":{"type":"string"}},"required":["maxParticipants","maxPrograms","name","version"],"additionalProperties":false},"slackTeamId":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"},{"const":"uninstalled"}]}},"required":["id","name","policy","slackTeamId","status"],"additionalProperties":false},"unitMemberships":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"memberId":{"type":"string"},"teamId":{"type":"string"},"unitId":{"type":"string"}},"required":["kind","memberId","teamId","unitId"],"additionalProperties":false}}},"required":["accessHistory","billingMembers","billingPeriods","enrollments","exportedAt","format","groupMembers","groups","legacyBillingHistory","legacyMatchingHistory","legacyMonthlyHistory","legacyRunHistory","legacySlackAssociationHistory","managerHistory","organizationUnits","pairs","participants","personAccess","personDirectory","personIdentities","programs","runMembers","runs","team","unitMemberships"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"exports.team"}},"/manage/getStarted/celebrate":{"post":{"operationId":"getStarted.celebrate","summary":"Record that a celebration was shown, shared or dismissed","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"achievement":{"type":"string"},"covered":{"type":"array","items":{"type":"string"}},"outcome":{"anyOf":[{"const":"dismissed"},{"const":"shared"},{"const":"shown"}]},"confirm":{"const":"getStarted.celebrate"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["achievement","outcome","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"first":{"type":"boolean"},"kind":{"anyOf":[{"const":"badge"},{"const":"done"},{"const":"hello"},{"const":"step"}]},"outcome":{"anyOf":[{"const":"dismissed"},{"const":"shared"},{"const":"shown"}]}},"required":["first","kind","outcome"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"getStarted.celebrate"}},"/manage/getStarted/celebration":{"post":{"operationId":"getStarted.celebration","summary":"Read the first-action celebration waiting for you, if any","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"null"},{"type":"object","properties":{"achievement":{"type":"string"},"badge":{"anyOf":[{"type":"null"},{"type":"object","properties":{"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"name":{"type":"string"}},"required":["imageUrl","name"],"additionalProperties":false}]},"covered":{"type":"array","items":{"type":"string"}},"detail":{"type":"string"},"kind":{"anyOf":[{"const":"badge"},{"const":"done"},{"const":"hello"},{"const":"step"}]},"shareText":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"}},"required":["achievement","badge","covered","detail","kind","shareText","title"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"getStarted.celebration"}},"/manage/getStarted/dismiss":{"post":{"operationId":"getStarted.dismiss","summary":"Hide the Get started card","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"getStarted.dismiss"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"dismissed":{"type":"boolean"}},"required":["dismissed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"getStarted.dismiss"}},"/manage/getStarted/draftIntro":{"post":{"operationId":"getStarted.draftIntro","summary":"Draft a short hello to your coworkers with Mello; nothing is posted","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"getStarted.draftIntro"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"by":{"anyOf":[{"const":"ai"},{"const":"rule"}]},"text":{"type":"string"}},"required":["by","text"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"getStarted.draftIntro"}},"/manage/getStarted/get":{"post":{"operationId":"getStarted.get","summary":"Read your own Get started steps and whether the welcome still shows","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"calendarProviders":{"type":"array","items":{"anyOf":[{"const":"google"},{"const":"microsoft"}]}},"intro":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"},"showCard":{"type":"boolean"},"showWizard":{"type":"boolean"},"steps":{"type":"array","items":{"type":"object","properties":{"done":{"type":"boolean"},"id":{"anyOf":[{"const":"ask"},{"const":"calendar"},{"const":"communities"},{"const":"introduce"},{"const":"profile"}]}},"required":["done","id"],"additionalProperties":false}}},"required":["calendarProviders","intro","personId","showCard","showWizard","steps"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"getStarted.get"}},"/manage/getStarted/intro":{"post":{"operationId":"getStarted.intro","summary":"Post your hello on Home, or skip it","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"action":{"const":"post"},"text":{"type":"string"},"confirm":{"const":"getStarted.intro"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["action","text","confirm","requestKey"],"additionalProperties":false},{"type":"object","properties":{"action":{"const":"skip"},"confirm":{"const":"getStarted.intro"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["action","confirm","requestKey"],"additionalProperties":false}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"action":{"const":"skip"},"first":{"type":"boolean"}},"required":["action","first"],"additionalProperties":false},{"type":"object","properties":{"action":{"const":"post"},"first":{"type":"boolean"}},"required":["action","first"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"getStarted.intro"}},"/manage/getStarted/wizard":{"post":{"operationId":"getStarted.wizard","summary":"Record that you opened, finished or skipped the welcome","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"anyOf":[{"const":"finished"},{"const":"opened"},{"const":"skipped"}]},"confirm":{"const":"getStarted.wizard"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["outcome","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"first":{"type":"boolean"}},"required":["first"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"getStarted.wizard"}},"/manage/home/feed":{"post":{"operationId":"home.feed","summary":"What happened to people you know, and who Mello thinks you should meet","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"covers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"items":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"date":{"type":"string"},"eventType":{"anyOf":[{"const":"anniversary"},{"const":"birthday"}]},"id":{"type":"string"},"kind":{"const":"milestone"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false},"years":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["at","date","eventType","id","kind","person","years"],"additionalProperties":false},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"badge":{"type":"object","properties":{"automaticKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"imageUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"kind":{"type":"string"},"name":{"type":"string"}},"required":["automaticKey","id","imageUrl","kind","name"],"additionalProperties":false},"id":{"type":"string"},"kind":{"const":"badge"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"required":["at","badge","id","kind","person"],"additionalProperties":false},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"id":{"type":"string"},"kind":{"const":"hello"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false},"text":{"type":"string"}},"required":["at","id","kind","person","text"],"additionalProperties":false},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"kind":{"const":"introduced"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"program":{"type":"string"}},"required":["at","channelId","id","kind","people","program"],"additionalProperties":false},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"communities":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"const":"interests"},{"const":"places"},{"const":"resource_group"},{"const":"skills"}]},"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"name":{"type":"string"}},"required":["category","coverUrl","id","name"],"additionalProperties":false}},"id":{"type":"string"},"kind":{"const":"community"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}}},"required":["at","communities","id","kind","people"],"additionalProperties":false}]}},"linked":{"type":"boolean"},"newHires":{"type":"array","items":{"type":"object","properties":{"buddy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false},"sameTeam":{"type":"boolean"},"startDate":{"type":"string"},"units":{"type":"array","items":{"type":"string"}}},"required":["buddy","email","id","person","sameTeam","startDate","units"],"additionalProperties":false}},"praise":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"channelPrivate":{"type":"boolean"},"giver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"id":{"type":"string"},"postedAt":{"type":"string","format":"date-time"},"reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"emoji":{"type":"string"}},"required":["count","emoji"],"additionalProperties":false}},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"hidden":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["hidden","id","name"],"additionalProperties":false}},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["channelId","channelName","channelPrivate","giver","id","postedAt","reactions","reason","recipients","slackUrl","text","values"],"additionalProperties":false}},"stories":{"type":"object","properties":{"forYou":{"type":"array","items":{"type":"string"}},"preferences":{"type":"object","properties":{"autoplay":{"type":"boolean"},"forYou":{"type":"boolean"},"stories":{"type":"boolean"},"view":{"anyOf":[{"const":"cards"},{"const":"compact"}]}},"required":["autoplay","forYou","stories","view"],"additionalProperties":false},"reactions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"counts":{"type":"object","properties":{"cake":{"type":"number"},"clap":{"type":"number"},"heart":{"type":"number"},"party":{"type":"number"},"wave":{"type":"number"}},"additionalProperties":false},"mine":{"type":"array","items":{"anyOf":[{"const":"cake"},{"const":"clap"},{"const":"heart"},{"const":"party"},{"const":"wave"}]}},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["counts","mine","people","total"],"additionalProperties":false}},"views":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"const":"seen"},{"const":"sent"},{"const":"skipped"}]}}},"required":["forYou","preferences","reactions","views"],"additionalProperties":false},"suggestions":{"type":"array","items":{"type":"object","properties":{"basis":{"anyOf":[{"const":"mutual"},{"const":"new"}]},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reasons":{"type":"array","items":{"type":"string"}},"score":{"type":"number"},"shared":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["basis","id","name","photoUrl","reasons","score","shared","slackUserId","title","userId"],"additionalProperties":false}}},"required":["covers","items","linked","newHires","praise","stories","suggestions"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"home.feed"}},"/manage/home/preferences":{"post":{"operationId":"home.preferences","summary":"Choose how Home looks: cards or compact, stories, autoplay, For you","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoplay":{"anyOf":[{"const":false},{"const":true}]},"forYou":{"anyOf":[{"const":false},{"const":true}]},"stories":{"anyOf":[{"const":false},{"const":true}]},"view":{"anyOf":[{"const":"cards"},{"const":"compact"}]},"confirm":{"const":"home.preferences"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"autoplay":{"type":"boolean"},"changed":{"type":"array","items":{"anyOf":[{"const":"autoplay"},{"const":"forYou"},{"const":"stories"},{"const":"view"}]}},"forYou":{"type":"boolean"},"stories":{"type":"boolean"},"view":{"anyOf":[{"const":"cards"},{"const":"compact"}]}},"required":["autoplay","changed","forYou","stories","view"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"home.preferences"}},"/manage/home/react":{"post":{"operationId":"home.react","summary":"Add or remove your emoji reaction on a Home moment","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emoji":{"anyOf":[{"const":"cake"},{"const":"clap"},{"const":"heart"},{"const":"party"},{"const":"wave"}]},"itemId":{"type":"string"},"on":{"type":"boolean"},"confirm":{"const":"home.react"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["emoji","itemId","on","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"counts":{"type":"object","properties":{"cake":{"type":"number"},"clap":{"type":"number"},"heart":{"type":"number"},"party":{"type":"number"},"wave":{"type":"number"}},"additionalProperties":false},"itemId":{"type":"string"},"mine":{"type":"array","items":{"anyOf":[{"const":"cake"},{"const":"clap"},{"const":"heart"},{"const":"party"},{"const":"wave"}]}},"on":{"type":"boolean"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["counts","itemId","mine","on","people","total"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"home.react"}},"/manage/home/story":{"post":{"operationId":"home.story","summary":"Record Home stories you opened, sent a note from, or skipped","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemIds":{"type":"array","items":{"type":"string"}},"outcome":{"anyOf":[{"const":"seen"},{"const":"sent"},{"const":"skipped"}]},"confirm":{"const":"home.story"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["itemIds","outcome","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"outcome":{"anyOf":[{"const":"seen"},{"const":"sent"},{"const":"skipped"}]},"recorded":{"type":"number"}},"required":["outcome","recorded"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"home.story"}},"/manage/hr/categories":{"post":{"operationId":"hr.categories","summary":"Read the HR request categories and response target","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"canConfigure":{"type":"boolean"},"categories":{"type":"array","items":{"type":"object","properties":{"accessPersonIds":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sensitive":{"type":"boolean"}},"required":["accessPersonIds","id","name","ownerPersonId","sensitive"],"additionalProperties":false}},"generatedAt":{"anyOf":[{"type":"null"},{"type":"string"}]},"responders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"personId":{"type":"string"}},"required":["name","personId"],"additionalProperties":false}},"responseTargetDays":{"type":"number"},"source":{"anyOf":[{"const":"hr"},{"const":"mello"},{"const":"starter"}]}},"required":["canConfigure","categories","generatedAt","responders","responseTargetDays","source"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.categories"}},"/manage/hr/command":{"post":{"operationId":"hr.command","summary":"Claim, release, reply to, note, categorize, resolve or reopen an HR request","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"anyOf":[{"const":"categorize"},{"const":"claim"},{"const":"note"},{"const":"release"},{"const":"reopen"},{"const":"reply"},{"const":"resolve"}]},"articleSourceId":{"type":"string"},"body":{"type":"string"},"caseId":{"type":"string"},"categoryId":{"type":"string"},"closeOutcome":{"anyOf":[{"const":"article"},{"const":"needs_article"},{"const":"no_article"}]},"expectedRevision":{"type":"number"},"requestId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["action","caseId","expectedRevision","requestId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"articleDraft":{"anyOf":[{"type":"null"},{"type":"object","properties":{"proposalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"prepared"},{"const":"unavailable"}]}},"required":["proposalId","status"],"additionalProperties":false}]},"caseId":{"type":"string"},"messageId":{"anyOf":[{"type":"null"},{"type":"string"}]},"revision":{"type":"number"}},"required":["articleDraft","caseId","messageId","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.command"}},"/manage/hr/configure":{"post":{"operationId":"hr.configure","summary":"Change the HR request destination","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"name":{"type":"string"},"responderPersonIds":{"type":"array","items":{"type":"string"}},"confirm":{"const":"hr.configure"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","name","responderPersonIds","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revision":{"type":"number"}},"required":["revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.configure"}},"/manage/hr/deliver":{"post":{"operationId":"hr.deliver","summary":"Deliver your HR reply to the employee","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caseId":{"type":"string"},"messageId":{"type":"string"},"confirm":{"const":"hr.deliver"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["caseId","messageId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.deliver"}},"/manage/hr/get":{"post":{"operationId":"hr.get","summary":"Read one HR request and its messages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caseId":{"type":"string"}},"required":["caseId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"case":{"type":"object","properties":{"articleProposalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"articleSourceId":{"anyOf":[{"type":"null"},{"type":"string"}]},"categorizedBy":{"anyOf":[{"type":"null"},{"const":"hr"},{"const":"mello"}]},"category":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sensitive":{"type":"boolean"}},"required":["id","name","sensitive"],"additionalProperties":false}]},"closeOutcome":{"anyOf":[{"type":"null"},{"const":"article"},{"const":"needs_article"},{"const":"no_article"}]},"createdAt":{"type":"string","format":"date-time"},"destinationName":{"type":"string"},"dueAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"employeePersonId":{"type":"string"},"id":{"type":"string"},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reopenCount":{"type":"number"},"replyChannel":{"type":"string"},"resolvedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sharedText":{"type":"string"},"status":{"anyOf":[{"const":"open"},{"const":"resolved"},{"const":"waiting_on_employee"},{"const":"waiting_on_hr"}]}},"required":["createdAt","destinationName","employeePersonId","id","ownerPersonId","reopenCount","replyChannel","resolvedAt","revision","sharedText","status"],"additionalProperties":false},"coverage":{"type":"object","properties":{"approved":{"type":"number"},"eligible":{"type":"number"}},"required":["approved","eligible"],"additionalProperties":false},"events":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"revision":{"type":"number"}},"required":["action","createdAt","id","revision"],"additionalProperties":false}},"messages":{"type":"array","items":{"type":"object","properties":{"attemptCount":{"type":"number"},"authorName":{"anyOf":[{"type":"null"},{"type":"string"}]},"authorPersonId":{"type":"string"},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"deliveryStatus":{"anyOf":[{"const":"delivered"},{"const":"failed"},{"const":"none"},{"const":"ready"},{"const":"sending"},{"const":"suppressed"},{"const":"unknown"}]},"id":{"type":"string"},"kind":{"anyOf":[{"const":"employee"},{"const":"hr_reply"},{"const":"internal_note"}]}},"required":["attemptCount","authorName","authorPersonId","body","createdAt","deliveryStatus","id","kind"],"additionalProperties":false}},"owner":{"anyOf":[{"type":"null"},{"type":"object","properties":{"eligible":{"type":"boolean"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"}},"required":["eligible","name","personId"],"additionalProperties":false}]},"ownerEligible":{"type":"boolean"},"personId":{"type":"string"},"responder":{"type":"boolean"}},"required":["case","coverage","events","messages","owner","ownerEligible","personId","responder"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.get"}},"/manage/hr/list":{"post":{"operationId":"hr.list","summary":"List the HR requests you asked or can answer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sensitive":{"type":"boolean"}},"required":["id","name","sensitive"],"additionalProperties":false}]},"conversationId":{"anyOf":[{"type":"null"},{"type":"string"}]},"coverage":{"type":"object","properties":{"approved":{"type":"number"},"eligible":{"type":"number"}},"required":["approved","eligible"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"destinationName":{"type":"string"},"dueAt":{"type":"string","format":"date-time"},"employeePersonId":{"type":"string"},"id":{"type":"string"},"owner":{"anyOf":[{"type":"null"},{"type":"object","properties":{"eligible":{"type":"boolean"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"}},"required":["eligible","name","personId"],"additionalProperties":false}]},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sharedText":{"type":"string"},"sourceOwnerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"open"},{"const":"resolved"},{"const":"waiting_on_employee"},{"const":"waiting_on_hr"}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["category","coverage","createdAt","destinationName","dueAt","employeePersonId","id","owner","ownerPersonId","sharedText","status","updatedAt"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.list"}},"/manage/hr/readiness":{"post":{"operationId":"hr.readiness","summary":"Check whether HR requests have a destination and someone to answer them","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"ready":{"type":"boolean"},"reason":{"const":"no_destination"},"responderCount":{"type":"number"}},"required":["ready","reason","responderCount"],"additionalProperties":false},{"type":"object","properties":{"ready":{"type":"boolean"},"reason":{"const":"no_active_responders"},"responderCount":{"type":"number"}},"required":["ready","reason","responderCount"],"additionalProperties":false},{"type":"object","properties":{"ready":{"type":"boolean"},"responderCount":{"type":"number"}},"required":["ready","responderCount"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.readiness"}},"/manage/hr/rebuildCategories":{"post":{"operationId":"hr.rebuildCategories","summary":"Have Mello rebuild the HR request categories from published Knowledge","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"hr.rebuildCategories"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"categories":{"type":"number"}},"required":["categories"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.rebuildCategories"}},"/manage/hr/renameTeam":{"post":{"operationId":"hr.renameTeam","summary":"Rename the HR team employees send requests to","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"revision":{"type":"number"}},"required":["changed","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.renameTeam"}},"/manage/hr/retryDelivery":{"post":{"operationId":"hr.retryDelivery","summary":"Retry HR request delivery","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string"},"confirm":{"const":"hr.retryDelivery"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["messageId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"messageId":{"type":"string"}},"required":["messageId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.retryDelivery"}},"/manage/hr/saveCategories":{"post":{"operationId":"hr.saveCategories","summary":"Save the HR request categories, their owners and the response target","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"accessPersonIds":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sensitive":{"anyOf":[{"const":false},{"const":true}]}},"required":["name"],"additionalProperties":false}},"responseTargetDays":{"type":"number"},"confirm":{"const":"hr.saveCategories"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["categories","responseTargetDays","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"categories":{"type":"number"}},"required":["categories"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.saveCategories"}},"/manage/hr/settings":{"post":{"operationId":"hr.settings","summary":"Read the HR team name and who answers HR requests","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"canConfigure":{"type":"boolean"},"candidates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"person_id":{"type":"string"}},"required":["name","person_id"],"additionalProperties":false}},"destination":{"anyOf":[{"type":"null"},{"type":"object","properties":{"categoriesClaimedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"categoriesGeneratedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"categoriesSource":{"anyOf":[{"const":"hr"},{"const":"mello"},{"const":"starter"}]},"name":{"type":"string"},"responseTargetDays":{"type":"number"},"revision":{"type":"number"},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["categoriesClaimedAt","categoriesGeneratedAt","categoriesSource","name","responseTargetDays","revision","teamId","updatedAt"],"additionalProperties":false}]},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]},"responders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"person_id":{"type":"string"}},"required":["name","person_id"],"additionalProperties":false}}},"required":["canConfigure","candidates","destination","personId","responders"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.settings"}},"/manage/hr/share":{"post":{"operationId":"hr.share","summary":"Share this request with the selected HR responders","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"conversationId":{"anyOf":[{"type":"null"},{"type":"string"}]},"destinationRevision":{"type":"number"},"requestId":{"type":"string"},"responderPersonIds":{"type":"array","items":{"type":"string"}},"sourceOwnerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"confirm":{"const":"hr.share"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["body","destinationRevision","requestId","responderPersonIds","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"caseId":{"type":"string"}},"required":["caseId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"hr.share"}},"/manage/hr/shareSources":{"post":{"operationId":"hr.shareSources","summary":"List your recent Mello conversations that an HR request can include","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"conversationId":{"type":"string"},"excerpt":{"type":"string"},"sourceOwnerId":{"type":"string"}},"required":["channel","conversationId","excerpt","sourceOwnerId"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"hr.shareSources"}},"/manage/identities/linkSlack":{"post":{"operationId":"identities.linkSlack","summary":"Link a verified Slack account","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"revision":{"type":"number"},"slackTeamId":{"type":"string"},"subject":{"type":"string"},"confirm":{"const":"identities.linkSlack"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","revision","slackTeamId","subject","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"issuer":{"type":"string"},"personId":{"type":"string"},"provider":{"type":"string"},"revision":{"type":"number"},"revokedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"verification":{"type":"string"},"verifiedAt":{"type":"string","format":"date-time"},"verifiedBy":{"type":"string"}},"required":["id","issuer","personId","provider","revision","revokedAt","subject","teamId","verification","verifiedAt","verifiedBy"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"identities.linkSlack"}},"/manage/identities/linkWeb":{"post":{"operationId":"identities.linkWeb","summary":"Link a verified web account","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"userId":{"type":"string"},"confirm":{"const":"identities.linkWeb"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","userId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"issuer":{"type":"string"},"personId":{"type":"string"},"provider":{"type":"string"},"revision":{"type":"number"},"revokedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"verification":{"type":"string"},"verifiedAt":{"type":"string","format":"date-time"},"verifiedBy":{"type":"string"}},"required":["id","issuer","personId","provider","revision","revokedAt","subject","teamId","verification","verifiedAt","verifiedBy"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"identities.linkWeb"}},"/manage/identities/list":{"post":{"operationId":"identities.list","summary":"List the Slack and web accounts linked to a person","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accountLabel":{"type":"string"},"id":{"type":"string"},"issuer":{"type":"string"},"personId":{"type":"string"},"provider":{"type":"string"},"revision":{"type":"number"},"revokedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"verification":{"type":"string"},"verifiedAt":{"type":"string","format":"date-time"},"verifiedBy":{"type":"string"}},"required":["accountLabel","id","issuer","personId","provider","revision","revokedAt","subject","teamId","verification","verifiedAt","verifiedBy"],"additionalProperties":false}},"slackConnected":{"type":"boolean"}},"required":["rows","slackConnected"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"identities.list"}},"/manage/identities/slackAccounts":{"post":{"operationId":"identities.slackAccounts","summary":"List Slack accounts that can be linked to people","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","personId"],"additionalProperties":false}},"nextCursor":{"type":"string"},"revision":{"type":"number"},"slackTeamId":{"type":"string"}},"required":["accounts","revision","slackTeamId"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"identities.slackAccounts"}},"/manage/identities/unlink":{"post":{"operationId":"identities.unlink","summary":"Revoke an employee identity link","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string"},"personId":{"type":"string"},"confirm":{"const":"identities.unlink"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["identityId","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revoked":{"type":"boolean"}},"required":["revoked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"identities.unlink"}},"/manage/identities/webAccounts":{"post":{"operationId":"identities.webAccounts","summary":"List web accounts that can be linked to people","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"awaitingAccess":{"anyOf":[{"const":false},{"const":true}]},"search":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"emailVerified":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]},"personName":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["email","emailVerified","id","name","personId","personName"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"identities.webAccounts"}},"/manage/integrations/authorize":{"post":{"operationId":"integrations.authorize","summary":"Get the link that connects Slack, Google Drive or Notion to the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"anyOf":[{"const":"google"},{"const":"notion"},{"const":"slack"}]}},"required":["provider"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string"},"requiresUserAction":{"const":true},"url":{"type":"string"}},"required":["reason","requiresUserAction","url"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"integrations.authorize"}},"/manage/invitations/cancel":{"post":{"operationId":"invitations.cancel","summary":"Cancel a pending workspace invitation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["id","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"email":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inviterId":{"type":"string"},"organizationId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"canceled"},{"const":"pending"},{"const":"rejected"}]},"teamId":{"type":"string"},"teamRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["createdAt","email","expiresAt","id","inviterId","organizationId","role","status","teamId","teamRole"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"invitations.cancel"}},"/manage/invitations/candidates":{"post":{"operationId":"invitations.candidates","summary":"List people in the directory who can be invited to the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["email","id","name"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"invitations.candidates"}},"/manage/invitations/create":{"post":{"operationId":"invitations.create","summary":"Invite this person with the selected team role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"}]},"confirm":{"const":"invitations.create"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["email","role","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"email":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inviterId":{"type":"string"},"organizationId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"canceled"},{"const":"pending"},{"const":"rejected"}]},"teamId":{"type":"string"},"teamRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["createdAt","email","expiresAt","id","inviterId","organizationId","role","status","teamId","teamRole"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"invitations.create"}},"/manage/invitations/createMany":{"post":{"operationId":"invitations.createMany","summary":"Invite these people with the selected team role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"role":{"anyOf":[{"const":"admin"},{"const":"member"}]},"confirm":{"const":"invitations.createMany"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["emails","role","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"alreadyInvited":{"type":"number"},"alreadyMember":{"type":"number"},"invited":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"email":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inviterId":{"type":"string"},"organizationId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"canceled"},{"const":"pending"},{"const":"rejected"}]},"teamId":{"type":"string"},"teamRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["createdAt","email","expiresAt","id","inviterId","organizationId","role","status","teamId","teamRole"],"additionalProperties":false}},"unsent":{"type":"number"}},"required":["alreadyInvited","alreadyMember","invited","unsent"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"invitations.createMany"}},"/manage/invitations/inviteDirectory":{"post":{"operationId":"invitations.inviteDirectory","summary":"Invite everyone in the directory who is not invited yet","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"invitations.inviteDirectory"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"alreadyInvited":{"type":"number"},"alreadyMember":{"type":"number"},"invited":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"email":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inviterId":{"type":"string"},"organizationId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"canceled"},{"const":"pending"},{"const":"rejected"}]},"teamId":{"type":"string"},"teamRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["createdAt","email","expiresAt","id","inviterId","organizationId","role","status","teamId","teamRole"],"additionalProperties":false}},"remaining":{"type":"number"},"unsent":{"type":"number"}},"required":["alreadyInvited","alreadyMember","invited","remaining","unsent"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"invitations.inviteDirectory"}},"/manage/invitations/list":{"post":{"operationId":"invitations.list","summary":"List pending workspace invitations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"email":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inviterId":{"type":"string"},"organizationId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"canceled"},{"const":"pending"},{"const":"rejected"}]},"teamId":{"type":"string"},"teamRole":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]}},"required":["createdAt","email","expiresAt","id","inviterId","organizationId","role","status","teamId","teamRole"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"invitations.list"}},"/manage/knowledge/connections/browse":{"post":{"operationId":"knowledge.connections.browse","summary":"List documents a connected Knowledge source can see","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"cursor":{"anyOf":[{"type":"null"},{"type":"string"}]},"parent":{"anyOf":[{"type":"null"},{"type":"string"}]},"query":{"type":"string"}},"required":["connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"anyOf":[{"const":"document"},{"const":"folder"}]},"location":{"anyOf":[{"type":"null"},{"type":"string"}]},"modifiedAt":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"}},"required":["id","kind","location","modifiedAt","title"],"additionalProperties":false}},"next":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["items","next"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.connections.browse"}},"/manage/knowledge/connections/connect":{"post":{"operationId":"knowledge.connections.connect","summary":"Connect a Knowledge provider with a token","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"provider":{"anyOf":[{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"sharepoint"},{"const":"website"}]},"confirm":{"const":"knowledge.connections.connect"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["fields","provider","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"revision":{"type":"number"}},"required":["id","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.connections.connect"}},"/manage/knowledge/connections/disconnect":{"post":{"operationId":"knowledge.connections.disconnect","summary":"Disconnect a knowledge provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"expectedRevision":{"type":"number"},"confirm":{"const":"knowledge.connections.disconnect"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["connectionId","expectedRevision","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"disconnected":{"type":"boolean"}},"required":["disconnected"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.connections.disconnect"}},"/manage/knowledge/connections/list":{"post":{"operationId":"knowledge.connections.list","summary":"List connected Knowledge providers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{"type":"array","items":{"type":"object","properties":{"auth":{"anyOf":[{"type":"object","properties":{"kind":{"const":"oauth"},"steps":{"type":"array","items":{"type":"string"}}},"required":["kind","steps"],"additionalProperties":false},{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"help":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"placeholder":{"type":"string"},"secret":{"type":"boolean"}},"required":["help","id","label","secret"],"additionalProperties":false}},"kind":{"const":"api_token"},"steps":{"type":"array","items":{"type":"string"}}},"required":["fields","kind","steps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"url"}},"required":["kind"],"additionalProperties":false}]},"availability":{"anyOf":[{"type":"object","properties":{"state":{"const":"available"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"note":{"type":"string"},"state":{"const":"partner_pending"}},"required":["note","state"],"additionalProperties":false},{"type":"object","properties":{"note":{"type":"string"},"state":{"const":"coming_soon"}},"required":["state"],"additionalProperties":false}]},"blurb":{"type":"string"},"capabilities":{"type":"object","properties":{"browse":{"type":"boolean"},"changeDetection":{"anyOf":[{"const":"content"},{"const":"revision"}]},"formats":{"type":"string"},"paste":{"type":"boolean"},"picker":{"anyOf":[{"type":"null"},{"const":"google"}]}},"required":["browse","changeDetection","formats","paste","picker"],"additionalProperties":false},"category":{"anyOf":[{"const":"drive"},{"const":"hris"},{"const":"web"},{"const":"wiki"}]},"configured":{"type":"boolean"},"docsHref":{"type":"string"},"id":{"anyOf":[{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"sharepoint"},{"const":"website"}]},"name":{"type":"string"},"slug":{"type":"string"}},"required":["auth","availability","blurb","capabilities","category","configured","id","name","slug"],"additionalProperties":false}},"connections":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"accountLabel":{"type":"string"},"canUse":{"type":"boolean"},"connectedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"provider":{"anyOf":[{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"sharepoint"},{"const":"website"}]},"revision":{"type":"number"},"revokedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"teamId":{"type":"string"}},"required":["accountId","accountLabel","canUse","connectedBy","createdAt","id","provider","revision","revokedAt","teamId"],"additionalProperties":false}}},"required":["catalog","connections"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.connections.list"}},"/manage/knowledge/connections/request":{"post":{"operationId":"knowledge.connections.request","summary":"Ask an administrator to connect a Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"name":{"type":"string"}},"required":["createdAt","name"],"additionalProperties":false}}},"required":["requests"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.connections.request"}},"/manage/knowledge/connections/requests":{"post":{"operationId":"knowledge.connections.requests","summary":"List requests to connect a Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"name":{"type":"string"}},"required":["createdAt","name"],"additionalProperties":false}}},"required":["requests"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.connections.requests"}},"/manage/knowledge/policies/coverage":{"post":{"operationId":"knowledge.policies.coverage","summary":"Check which common HR policies Knowledge covers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"policies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"source":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false}]}},"required":["id","source"],"additionalProperties":false}}},"required":["policies"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.policies.coverage"}},"/manage/knowledge/sources/archive":{"post":{"operationId":"knowledge.sources.archive","summary":"Archive an unpublished knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"sourceId":{"type":"string"},"confirm":{"const":"knowledge.sources.archive"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","sourceId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"archived":{"type":"boolean"},"revision":{"type":"number"}},"required":["archived","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.archive"}},"/manage/knowledge/sources/changeAudience":{"post":{"operationId":"knowledge.sources.changeAudience","summary":"Change who can read this knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"expectedRevision":{"type":"number"},"sourceId":{"type":"string"},"confirm":{"const":"knowledge.sources.changeAudience"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["audience","expectedRevision","sourceId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"published":{"type":"boolean"},"source":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"archivedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"connectionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"documentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"effectiveAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"externalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"latestVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"ownerId":{"type":"string"},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"publishedAudience":{"anyOf":[{"type":"null"},{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"publishedAudienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"publishedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reviewAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sectionKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"syncStatus":{"anyOf":[{"type":"null"},{"const":"current"},{"const":"draft"},{"const":"error"},{"const":"removed"},{"const":"unavailable"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]},"withdrawnAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["archivedAt","archivedBy","checkedAt","connectionId","createdAt","documentId","effectiveAt","externalId","id","latestVersionId","ownerId","publishedAt","publishedAudience","publishedAudienceRules","publishedBy","publishedVersionId","reviewAt","revision","sectionKey","syncStatus","teamId","updatedAt","withdrawalReason","withdrawnAt"],"additionalProperties":false}},"required":["published","source"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.changeAudience"}},"/manage/knowledge/sources/get":{"post":{"operationId":"knowledge.sources.get","summary":"Read a Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceId":{"type":"string"},"versionId":{"type":"string"}},"required":["sourceId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"canManage":{"type":"boolean"},"document":{"type":"object","properties":{"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"kind":{"anyOf":[{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"sharepoint"},{"const":"upload"},{"const":"website"}]},"name":{"type":"string"},"revision":{"type":"number"}},"required":["checkedAt","format","id","kind","name","revision"],"additionalProperties":false},"source":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"archivedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"connectionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"documentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"effectiveAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"externalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"latestVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"ownerId":{"type":"string"},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"publishedAudience":{"anyOf":[{"type":"null"},{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"publishedAudienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"publishedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reviewAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sectionKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"syncStatus":{"anyOf":[{"type":"null"},{"const":"current"},{"const":"draft"},{"const":"error"},{"const":"removed"},{"const":"unavailable"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]},"withdrawnAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["archivedAt","archivedBy","checkedAt","connectionId","createdAt","documentId","effectiveAt","externalId","id","latestVersionId","ownerId","publishedAt","publishedAudience","publishedAudienceRules","publishedBy","publishedVersionId","reviewAt","revision","sectionKey","syncStatus","teamId","updatedAt","withdrawalReason","withdrawnAt"],"additionalProperties":false},"sync":{"type":"object","properties":{"failures":{"type":"number"},"lastAttemptAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"nextAttemptAt":{"type":"string","format":"date-time"}},"required":["failures","lastAttemptAt","nextAttemptAt"],"additionalProperties":false},"version":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"body":{"type":"string"},"contentHash":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"effectiveAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"provenance":{"type":"object","properties":{"documentId":{"type":"string"},"edited":{"anyOf":[{"const":false},{"const":true}]},"externalId":{"type":"string"},"firstPage":{"type":"number"},"format":{"anyOf":[{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"importHash":{"type":"string"},"kind":{"anyOf":[{"const":"article"},{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"pdf"},{"const":"sharepoint"},{"const":"upload"},{"const":"website"}]},"lastPage":{"type":"number"},"modifiedAt":{"type":"string"},"name":{"type":"string"},"section":{"type":"number"},"sectionKey":{"type":"string"},"sections":{"type":"number"},"uploadId":{"type":"string"}},"required":["kind"],"additionalProperties":false},"reviewAt":{"type":"string","format":"date-time"},"sourceId":{"type":"string"},"teamId":{"type":"string"},"title":{"type":"string"}},"required":["audience","audienceRules","body","contentHash","createdAt","createdBy","effectiveAt","id","provenance","reviewAt","sourceId","teamId","title"],"additionalProperties":false}},"required":["canManage","source","version"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.sources.get"}},"/manage/knowledge/sources/history":{"post":{"operationId":"knowledge.sources.history","summary":"List a Knowledge source's versions","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceId":{"type":"string"}},"required":["sourceId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"contentHash":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"effectiveAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"provenance":{"type":"object","properties":{"documentId":{"type":"string"},"edited":{"anyOf":[{"const":false},{"const":true}]},"externalId":{"type":"string"},"firstPage":{"type":"number"},"format":{"anyOf":[{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"importHash":{"type":"string"},"kind":{"anyOf":[{"const":"article"},{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"pdf"},{"const":"sharepoint"},{"const":"upload"},{"const":"website"}]},"lastPage":{"type":"number"},"modifiedAt":{"type":"string"},"name":{"type":"string"},"section":{"type":"number"},"sectionKey":{"type":"string"},"sections":{"type":"number"},"uploadId":{"type":"string"}},"required":["kind"],"additionalProperties":false},"reviewAt":{"type":"string","format":"date-time"},"sourceId":{"type":"string"},"teamId":{"type":"string"},"title":{"type":"string"}},"required":["audience","audienceRules","contentHash","createdAt","createdBy","effectiveAt","id","provenance","reviewAt","sourceId","teamId","title"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.sources.history"}},"/manage/knowledge/sources/importConnected":{"post":{"operationId":"knowledge.sources.importConnected","summary":"Import a document from a connected Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"externalId":{"type":"string"},"confirm":{"const":"knowledge.sources.importConnected"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["connectionId","externalId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"documentId":{"type":"string"},"needsReview":{"type":"array","items":{"type":"string"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"reading"},{"const":"unchanged"}]},"uploadId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["changed","documentId","needsReview","sourceIds","status","uploadId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.importConnected"}},"/manage/knowledge/sources/importWebsite":{"post":{"operationId":"knowledge.sources.importWebsite","summary":"Import a website page into Knowledge for review","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"anyOf":[{"type":"object","properties":{"type":{"const":"none"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"token":{"type":"string"},"type":{"const":"bearer"}},"required":["token","type"],"additionalProperties":false},{"type":"object","properties":{"password":{"type":"string"},"type":{"const":"basic"},"username":{"type":"string"}},"required":["password","type","username"],"additionalProperties":false},{"type":"object","properties":{"header":{"anyOf":[{"const":"api-key"},{"const":"x-api-key"},{"const":"x-auth-token"}]},"token":{"type":"string"},"type":{"const":"api_key"}},"required":["header","token","type"],"additionalProperties":false},{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"type":{"const":"cloudflare_access"}},"required":["clientId","clientSecret","type"],"additionalProperties":false}]},"url":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["auth","url","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"documentId":{"type":"string"},"needsReview":{"type":"array","items":{"type":"string"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"reading"},{"const":"unchanged"}]},"uploadId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["changed","documentId","needsReview","sourceIds","status","uploadId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.importWebsite"}},"/manage/knowledge/sources/list":{"post":{"operationId":"knowledge.sources.list","summary":"List Knowledge sources","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id"],"additionalProperties":false},"query":{"type":"string"},"scope":{"anyOf":[{"const":"active"},{"const":"archived"}]},"sort":{"anyOf":[{"const":"name"},{"const":"updated"}]},"status":{"anyOf":[{"const":"Access lost"},{"const":"Access restored"},{"const":"Changes need review"},{"const":"Check overdue"},{"const":"Draft"},{"const":"Needs review"},{"const":"Published"},{"const":"Removed from source"},{"const":"Review due soon"},{"const":"Scheduled"},{"const":"Sync needs attention"},{"const":"Withdrawn"},{"const":"all"},{"const":"attention"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"archived":{"type":"number"},"canManage":{"type":"boolean"},"counts":{"type":"object","properties":{"Access lost":{"type":"number"},"Access restored":{"type":"number"},"Changes need review":{"type":"number"},"Check overdue":{"type":"number"},"Draft":{"type":"number"},"Needs review":{"type":"number"},"Published":{"type":"number"},"Removed from source":{"type":"number"},"Review due soon":{"type":"number"},"Scheduled":{"type":"number"},"Sync needs attention":{"type":"number"},"Withdrawn":{"type":"number"}},"additionalProperties":false},"needsAttention":{"type":"number"},"nextCursor":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"updatedAt":{"not":{}}},"required":["id","name"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"name":{"not":{}},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","updatedAt"],"additionalProperties":false}]},"rows":{"type":"array","items":{"type":"object","properties":{"source":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"archivedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"connectionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"documentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"effectiveAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"externalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"latestVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"ownerId":{"type":"string"},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"publishedAudience":{"anyOf":[{"type":"null"},{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"publishedAudienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"publishedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reviewAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sectionKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"syncStatus":{"anyOf":[{"type":"null"},{"const":"current"},{"const":"draft"},{"const":"error"},{"const":"removed"},{"const":"unavailable"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]},"withdrawnAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["archivedAt","archivedBy","checkedAt","connectionId","createdAt","documentId","effectiveAt","externalId","id","latestVersionId","ownerId","publishedAt","publishedAudience","publishedAudienceRules","publishedBy","publishedVersionId","reviewAt","revision","sectionKey","syncStatus","teamId","updatedAt","withdrawalReason","withdrawnAt"],"additionalProperties":false},"status":{"anyOf":[{"const":"Access lost"},{"const":"Access restored"},{"const":"Changes need review"},{"const":"Check overdue"},{"const":"Draft"},{"const":"Needs review"},{"const":"Published"},{"const":"Removed from source"},{"const":"Review due soon"},{"const":"Scheduled"},{"const":"Sync needs attention"},{"const":"Withdrawn"}]},"version":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"contentHash":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"effectiveAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"provenance":{"type":"object","properties":{"documentId":{"type":"string"},"edited":{"anyOf":[{"const":false},{"const":true}]},"externalId":{"type":"string"},"firstPage":{"type":"number"},"format":{"anyOf":[{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"importHash":{"type":"string"},"kind":{"anyOf":[{"const":"article"},{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"pdf"},{"const":"sharepoint"},{"const":"upload"},{"const":"website"}]},"lastPage":{"type":"number"},"modifiedAt":{"type":"string"},"name":{"type":"string"},"section":{"type":"number"},"sectionKey":{"type":"string"},"sections":{"type":"number"},"uploadId":{"type":"string"}},"required":["kind"],"additionalProperties":false},"reviewAt":{"type":"string","format":"date-time"},"sourceId":{"type":"string"},"teamId":{"type":"string"},"title":{"type":"string"}},"required":["audience","audienceRules","contentHash","createdAt","createdBy","effectiveAt","id","provenance","reviewAt","sourceId","teamId","title"],"additionalProperties":false}},"required":["source","status","version"],"additionalProperties":false}},"scope":{"anyOf":[{"const":"active"},{"const":"archived"}]}},"required":["archived","canManage","counts","needsAttention","nextCursor","rows","scope"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.sources.list"}},"/manage/knowledge/sources/publish":{"post":{"operationId":"knowledge.sources.publish","summary":"Publish this knowledge version to its audience","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"sourceId":{"type":"string"},"versionId":{"type":"string"},"confirm":{"const":"knowledge.sources.publish"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","sourceId","versionId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"archivedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"connectionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"documentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"effectiveAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"externalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"latestVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"ownerId":{"type":"string"},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"publishedAudience":{"anyOf":[{"type":"null"},{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"publishedAudienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"publishedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reviewAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sectionKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"syncStatus":{"anyOf":[{"type":"null"},{"const":"current"},{"const":"draft"},{"const":"error"},{"const":"removed"},{"const":"unavailable"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]},"withdrawnAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["archivedAt","archivedBy","checkedAt","connectionId","createdAt","documentId","effectiveAt","externalId","id","latestVersionId","ownerId","publishedAt","publishedAudience","publishedAudienceRules","publishedBy","publishedVersionId","reviewAt","revision","sectionKey","syncStatus","teamId","updatedAt","withdrawalReason","withdrawnAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.publish"}},"/manage/knowledge/sources/refresh":{"post":{"operationId":"knowledge.sources.refresh","summary":"Refresh a Knowledge source from its connected provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"externalId":{"type":"string"},"refresh":{"type":"object","properties":{"documentId":{"type":"string"},"expectedRevision":{"type":"number"}},"required":["documentId","expectedRevision"],"additionalProperties":false},"replaceLocalDraft":{"anyOf":[{"const":false},{"const":true}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["connectionId","externalId","refresh","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"documentId":{"type":"string"},"needsReview":{"type":"array","items":{"type":"string"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"reading"},{"const":"unchanged"}]},"uploadId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["changed","documentId","needsReview","sourceIds","status","uploadId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.refresh"}},"/manage/knowledge/sources/restore":{"post":{"operationId":"knowledge.sources.restore","summary":"Restore an archived knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"sourceId":{"type":"string"},"confirm":{"const":"knowledge.sources.restore"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","sourceId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"archived":{"type":"boolean"},"revision":{"type":"number"}},"required":["archived","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.restore"}},"/manage/knowledge/sources/save":{"post":{"operationId":"knowledge.sources.save","summary":"Save a Knowledge source draft","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"body":{"type":"string"},"effectiveAt":{"type":"string","format":"date-time"},"expectedRevision":{"type":"number"},"reviewAt":{"type":"string","format":"date-time"},"sourceId":{"type":"string"},"title":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["audience","body","effectiveAt","expectedRevision","reviewAt","sourceId","title","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"source":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"archivedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"connectionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"documentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"effectiveAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"externalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"latestVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"ownerId":{"type":"string"},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"publishedAudience":{"anyOf":[{"type":"null"},{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"publishedAudienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"publishedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedVersionId":{"anyOf":[{"type":"null"},{"type":"string"}]},"reviewAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"sectionKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"syncStatus":{"anyOf":[{"type":"null"},{"const":"current"},{"const":"draft"},{"const":"error"},{"const":"removed"},{"const":"unavailable"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]},"withdrawnAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["archivedAt","archivedBy","checkedAt","connectionId","createdAt","documentId","effectiveAt","externalId","id","latestVersionId","ownerId","publishedAt","publishedAudience","publishedAudienceRules","publishedBy","publishedVersionId","reviewAt","revision","sectionKey","syncStatus","teamId","updatedAt","withdrawalReason","withdrawnAt"],"additionalProperties":false},"version":{"type":"object","properties":{"audience":{"anyOf":[{"const":"admins"},{"const":"directory"},{"const":"everyone"}]},"audienceRules":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"const":"individual_contributors"},{"const":"managers"}]}},"units":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"body":{"type":"string"},"contentHash":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"effectiveAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"provenance":{"type":"object","properties":{"documentId":{"type":"string"},"edited":{"anyOf":[{"const":false},{"const":true}]},"externalId":{"type":"string"},"firstPage":{"type":"number"},"format":{"anyOf":[{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"importHash":{"type":"string"},"kind":{"anyOf":[{"const":"article"},{"const":"bamboohr"},{"const":"box"},{"const":"confluence"},{"const":"dropbox"},{"const":"google_drive"},{"const":"guru"},{"const":"notion"},{"const":"pdf"},{"const":"sharepoint"},{"const":"upload"},{"const":"website"}]},"lastPage":{"type":"number"},"modifiedAt":{"type":"string"},"name":{"type":"string"},"section":{"type":"number"},"sectionKey":{"type":"string"},"sections":{"type":"number"},"uploadId":{"type":"string"}},"required":["kind"],"additionalProperties":false},"reviewAt":{"type":"string","format":"date-time"},"sourceId":{"type":"string"},"teamId":{"type":"string"},"title":{"type":"string"}},"required":["audience","audienceRules","body","contentHash","createdAt","createdBy","effectiveAt","id","provenance","reviewAt","sourceId","teamId","title"],"additionalProperties":false}},"required":["source","version"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.save"}},"/manage/knowledge/sources/search":{"post":{"operationId":"knowledge.sources.search","summary":"Search Knowledge sources by title","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"body":{"type":"string"},"id":{"type":"string"},"sourceId":{"type":"string"},"title":{"type":"string"}},"required":["body","id","sourceId","title"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.sources.search"}},"/manage/knowledge/sources/withdraw":{"post":{"operationId":"knowledge.sources.withdraw","summary":"Withdraw a published Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"sourceId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","sourceId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"withdrawn":{"type":"boolean"}},"required":["withdrawn"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.withdraw"}},"/manage/knowledge/sources/write":{"post":{"operationId":"knowledge.sources.write","summary":"Write a Knowledge page with Mello from its title and a request; nothing is saved","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"kind":{"anyOf":[{"const":"article"},{"const":"company-values"}]},"prompt":{"type":"string"},"title":{"type":"string"},"confirm":{"const":"knowledge.sources.write"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"body":{"type":"string"},"title":{"type":"string"}},"required":["body","title"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.sources.write"}},"/manage/knowledge/uploads/appendPart":{"post":{"operationId":"knowledge.uploads.appendPart","summary":"Upload the next part of a Knowledge file","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"base64":{"type":"string"},"part":{"type":"number"},"sha256":{"type":"string"},"uploadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["base64","part","uploadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"byteSize":{"type":"number"},"canRetry":{"type":"boolean"},"chunkBytes":{"type":"number"},"chunkCount":{"type":"number"},"documentId":{"type":"string"},"error":{"anyOf":[{"type":"null"},{"type":"string"}]},"errorCode":{"anyOf":[{"type":"null"},{"const":"access"},{"const":"encrypted"},{"const":"interrupted"},{"const":"no_text"},{"const":"ocr_failed"},{"const":"ocr_limit"},{"const":"ocr_unavailable"},{"const":"quota"},{"const":"too_many_pages"},{"const":"unreadable"},{"const":"unsupported"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"name":{"type":"string"},"ocrPages":{"type":"number"},"ocrRead":{"type":"number"},"pageCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"pagesRead":{"type":"number"},"received":{"type":"array","items":{"type":"number"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"failed"},{"const":"parsing"},{"const":"queued"},{"const":"uploading"}]},"updatedAt":{"type":"string"}},"required":["byteSize","canRetry","chunkBytes","chunkCount","documentId","error","errorCode","format","id","name","ocrPages","ocrRead","pageCount","pagesRead","received","sourceIds","status","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.uploads.appendPart"}},"/manage/knowledge/uploads/complete":{"post":{"operationId":"knowledge.uploads.complete","summary":"Finish a Knowledge file upload and start reading it","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["uploadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"byteSize":{"type":"number"},"canRetry":{"type":"boolean"},"chunkBytes":{"type":"number"},"chunkCount":{"type":"number"},"documentId":{"type":"string"},"error":{"anyOf":[{"type":"null"},{"type":"string"}]},"errorCode":{"anyOf":[{"type":"null"},{"const":"access"},{"const":"encrypted"},{"const":"interrupted"},{"const":"no_text"},{"const":"ocr_failed"},{"const":"ocr_limit"},{"const":"ocr_unavailable"},{"const":"quota"},{"const":"too_many_pages"},{"const":"unreadable"},{"const":"unsupported"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"name":{"type":"string"},"ocrPages":{"type":"number"},"ocrRead":{"type":"number"},"pageCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"pagesRead":{"type":"number"},"received":{"type":"array","items":{"type":"number"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"failed"},{"const":"parsing"},{"const":"queued"},{"const":"uploading"}]},"updatedAt":{"type":"string"}},"required":["byteSize","canRetry","chunkBytes","chunkCount","documentId","error","errorCode","format","id","name","ocrPages","ocrRead","pageCount","pagesRead","received","sourceIds","status","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.uploads.complete"}},"/manage/knowledge/uploads/create":{"post":{"operationId":"knowledge.uploads.create","summary":"Start uploading a file to Knowledge","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mime":{"type":"string"},"name":{"type":"string"},"sha256":{"type":"string"},"size":{"type":"number"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","sha256","size","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"byteSize":{"type":"number"},"canRetry":{"type":"boolean"},"chunkBytes":{"type":"number"},"chunkCount":{"type":"number"},"documentId":{"type":"string"},"error":{"anyOf":[{"type":"null"},{"type":"string"}]},"errorCode":{"anyOf":[{"type":"null"},{"const":"access"},{"const":"encrypted"},{"const":"interrupted"},{"const":"no_text"},{"const":"ocr_failed"},{"const":"ocr_limit"},{"const":"ocr_unavailable"},{"const":"quota"},{"const":"too_many_pages"},{"const":"unreadable"},{"const":"unsupported"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"name":{"type":"string"},"ocrPages":{"type":"number"},"ocrRead":{"type":"number"},"pageCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"pagesRead":{"type":"number"},"received":{"type":"array","items":{"type":"number"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"failed"},{"const":"parsing"},{"const":"queued"},{"const":"uploading"}]},"updatedAt":{"type":"string"}},"required":["byteSize","canRetry","chunkBytes","chunkCount","documentId","error","errorCode","format","id","name","ocrPages","ocrRead","pageCount","pagesRead","received","sourceIds","status","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.uploads.create"}},"/manage/knowledge/uploads/get":{"post":{"operationId":"knowledge.uploads.get","summary":"Read the progress of a Knowledge file upload","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string"}},"required":["uploadId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"byteSize":{"type":"number"},"canRetry":{"type":"boolean"},"chunkBytes":{"type":"number"},"chunkCount":{"type":"number"},"documentId":{"type":"string"},"error":{"anyOf":[{"type":"null"},{"type":"string"}]},"errorCode":{"anyOf":[{"type":"null"},{"const":"access"},{"const":"encrypted"},{"const":"interrupted"},{"const":"no_text"},{"const":"ocr_failed"},{"const":"ocr_limit"},{"const":"ocr_unavailable"},{"const":"quota"},{"const":"too_many_pages"},{"const":"unreadable"},{"const":"unsupported"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"name":{"type":"string"},"ocrPages":{"type":"number"},"ocrRead":{"type":"number"},"pageCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"pagesRead":{"type":"number"},"received":{"type":"array","items":{"type":"number"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"failed"},{"const":"parsing"},{"const":"queued"},{"const":"uploading"}]},"updatedAt":{"type":"string"}},"required":["byteSize","canRetry","chunkBytes","chunkCount","documentId","error","errorCode","format","id","name","ocrPages","ocrRead","pageCount","pagesRead","received","sourceIds","status","updatedAt"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.uploads.get"}},"/manage/knowledge/uploads/retry":{"post":{"operationId":"knowledge.uploads.retry","summary":"Retry reading a Knowledge file that failed","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["uploadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"byteSize":{"type":"number"},"canRetry":{"type":"boolean"},"chunkBytes":{"type":"number"},"chunkCount":{"type":"number"},"documentId":{"type":"string"},"error":{"anyOf":[{"type":"null"},{"type":"string"}]},"errorCode":{"anyOf":[{"type":"null"},{"const":"access"},{"const":"encrypted"},{"const":"interrupted"},{"const":"no_text"},{"const":"ocr_failed"},{"const":"ocr_limit"},{"const":"ocr_unavailable"},{"const":"quota"},{"const":"too_many_pages"},{"const":"unreadable"},{"const":"unsupported"}]},"format":{"anyOf":[{"type":"null"},{"const":"docx"},{"const":"html"},{"const":"markdown"},{"const":"pdf"},{"const":"pptx"},{"const":"text"}]},"id":{"type":"string"},"name":{"type":"string"},"ocrPages":{"type":"number"},"ocrRead":{"type":"number"},"pageCount":{"anyOf":[{"type":"null"},{"type":"number"}]},"pagesRead":{"type":"number"},"received":{"type":"array","items":{"type":"number"}},"sourceIds":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"const":"completed"},{"const":"failed"},{"const":"parsing"},{"const":"queued"},{"const":"uploading"}]},"updatedAt":{"type":"string"}},"required":["byteSize","canRetry","chunkBytes","chunkCount","documentId","error","errorCode","format","id","name","ocrPages","ocrRead","pageCount","pagesRead","received","sourceIds","status","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"knowledge.uploads.retry"}},"/knowledge/context":{"post":{"operationId":"knowledge.context","summary":"Read nearby passages from the same currently approved version","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"passageId":{"type":"string","pattern":"^passage-[1-9]\\d{0,2}$"},"sourceId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"}},"required":["passageId","sourceId","versionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","maxItems":3,"items":{"type":"object","properties":{"href":{"type":"string"},"kind":{"enum":["knowledge","manager","directory"],"type":"string"},"passageId":{"type":"string"},"quote":{"type":"string"},"sourceId":{"type":"string"},"title":{"type":"string"},"versionId":{"type":"string"}},"required":["href","passageId","quote","sourceId","title","versionId"]}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.context"}},"/knowledge/search":{"post":{"operationId":"knowledge.search","summary":"Search currently approved knowledge and return immutable passage citations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":2,"maxLength":500}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","maxItems":8,"items":{"type":"object","properties":{"href":{"type":"string"},"kind":{"enum":["knowledge","manager","directory"],"type":"string"},"passageId":{"type":"string"},"quote":{"type":"string"},"sourceId":{"type":"string"},"title":{"type":"string"},"versionId":{"type":"string"}},"required":["href","passageId","quote","sourceId","title","versionId"]}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"knowledge.search"}},"/manage/network/claim":{"post":{"operationId":"network.claim","summary":"Say you know someone or would like to meet them","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"anyOf":[{"const":"knows"},{"const":"wants_to_meet"}]},"on":{"type":"boolean"},"personId":{"type":"string"},"confirm":{"const":"network.claim"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","on","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"confirmed":{"type":"boolean"},"knows":{"type":"boolean"},"wantsToMeet":{"type":"boolean"}},"required":["confirmed","knows","wantsToMeet"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"network.claim"}},"/manage/network/mine":{"post":{"operationId":"network.mine","summary":"Who you know and who you should meet","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"linked":{"const":false},"noSuggestions":{"type":"null"},"suggestions":{"type":"array","items":{"type":"object","properties":{"basis":{"anyOf":[{"const":"mutual"},{"const":"new"}]},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reasons":{"type":"array","items":{"type":"string"}},"score":{"type":"number"},"shared":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["basis","id","name","photoUrl","reasons","score","shared","slackUserId","title","userId"],"additionalProperties":false}},"ties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sources":{"type":"array","items":{"anyOf":[{"const":"buddy"},{"const":"confirmed"},{"const":"introduced"},{"const":"reporting_line"},{"const":"team"}]}},"strength":{"type":"number"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","sources","strength","title","userId"],"additionalProperties":false}}},"required":["linked","noSuggestions","suggestions","ties"],"additionalProperties":false},{"type":"object","properties":{"linked":{"const":true},"noSuggestions":{"anyOf":[{"type":"null"},{"const":"knows_everyone"},{"const":"no_coworkers"}]},"suggestions":{"type":"array","items":{"type":"object","properties":{"basis":{"anyOf":[{"const":"mutual"},{"const":"new"}]},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reasons":{"type":"array","items":{"type":"string"}},"score":{"type":"number"},"shared":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["basis","id","name","photoUrl","reasons","score","shared","slackUserId","title","userId"],"additionalProperties":false}},"ties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sources":{"type":"array","items":{"anyOf":[{"const":"buddy"},{"const":"confirmed"},{"const":"introduced"},{"const":"reporting_line"},{"const":"team"}]}},"strength":{"type":"number"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","sources","strength","title","userId"],"additionalProperties":false}}},"required":["linked","noSuggestions","suggestions","ties"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"network.mine"}},"/manage/network/ofPerson":{"post":{"operationId":"network.ofPerson","summary":"People you and this person both know","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"claims":{"anyOf":[{"type":"null"},{"type":"object","properties":{"confirmed":{"type":"boolean"},"knows":{"type":"boolean"},"wantsToMeet":{"type":"boolean"}},"required":["confirmed","knows","wantsToMeet"],"additionalProperties":false}]},"hidden":{"type":"boolean"},"inCommon":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"self":{"type":"boolean"},"tie":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"sources":{"type":"array","items":{"anyOf":[{"const":"buddy"},{"const":"confirmed"},{"const":"introduced"},{"const":"reporting_line"},{"const":"team"}]}},"strength":{"type":"number"}},"required":["id","sources","strength"],"additionalProperties":false}]},"tieCount":{"type":"null"}},"required":["claims","hidden","inCommon","self","tie","tieCount"],"additionalProperties":false},{"type":"object","properties":{"claims":{"anyOf":[{"type":"null"},{"type":"object","properties":{"confirmed":{"type":"boolean"},"knows":{"type":"boolean"},"wantsToMeet":{"type":"boolean"}},"required":["confirmed","knows","wantsToMeet"],"additionalProperties":false}]},"hidden":{"type":"boolean"},"inCommon":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"self":{"type":"boolean"},"tie":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"sources":{"type":"array","items":{"anyOf":[{"const":"buddy"},{"const":"confirmed"},{"const":"introduced"},{"const":"reporting_line"},{"const":"team"}]}},"strength":{"type":"number"}},"required":["id","sources","strength"],"additionalProperties":false}]},"tieCount":{"type":"number"}},"required":["claims","hidden","inCommon","self","tie","tieCount"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"network.ofPerson"}},"/manage/network/orgChart":{"post":{"operationId":"network.orgChart","summary":"Everyone in the team with their manager, for the org chart","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ownPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"rows":{"type":"array","items":{"type":"object","properties":{"department":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"teams":{"type":"array","items":{"type":"string"}},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["department","id","managerId","name","photoUrl","teams","title","userId"],"additionalProperties":false}}},"required":["ownPersonId","rows"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"network.orgChart"}},"/manage/notifications/preferences":{"post":{"operationId":"notifications.preferences","summary":"Read your notification preferences","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"const":"programs"},{"const":"requests"},{"const":"shuffl"}]},"kinds":{"type":"array","items":{"anyOf":[{"const":"billing_limit"},{"const":"celebration"},{"const":"connections_intro"},{"const":"hr_digest"},{"const":"hr_reply"},{"const":"hr_request"},{"const":"onboarding"},{"const":"praise"},{"const":"product_updates"},{"const":"pulse"},{"const":"pulse_results"},{"const":"support_new"},{"const":"support_reply"}]}},"title":{"anyOf":[{"const":"From Shuffl"},{"const":"Programs"},{"const":"Requests and support"}]}},"required":["id","kinds","title"],"additionalProperties":false}},"preferences":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{"anyOf":[{"const":"email"},{"const":"slack"},{"const":"teams"}]}},"email":{"type":"boolean"},"kind":{"anyOf":[{"const":"billing_limit"},{"const":"celebration"},{"const":"connections_intro"},{"const":"hr_digest"},{"const":"hr_reply"},{"const":"hr_request"},{"const":"onboarding"},{"const":"praise"},{"const":"product_updates"},{"const":"pulse"},{"const":"pulse_results"},{"const":"support_new"},{"const":"support_reply"}]},"slack":{"type":"boolean"},"teams":{"type":"boolean"}},"required":["channels","email","kind","slack","teams"],"additionalProperties":false}},"slackLinked":{"type":"boolean"}},"required":["groups","preferences","slackLinked"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"notifications.preferences"}},"/manage/notifications/save":{"post":{"operationId":"notifications.save","summary":"Save a notification preference","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"anyOf":[{"const":"email"},{"const":"slack"},{"const":"teams"}]},"enabled":{"type":"boolean"},"kind":{"anyOf":[{"const":"billing_limit"},{"const":"celebration"},{"const":"connections_intro"},{"const":"hr_digest"},{"const":"hr_reply"},{"const":"hr_request"},{"const":"onboarding"},{"const":"praise"},{"const":"product_updates"},{"const":"pulse"},{"const":"pulse_results"},{"const":"support_new"},{"const":"support_reply"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channel","enabled","kind","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"const":"programs"},{"const":"requests"},{"const":"shuffl"}]},"kinds":{"type":"array","items":{"anyOf":[{"const":"billing_limit"},{"const":"celebration"},{"const":"connections_intro"},{"const":"hr_digest"},{"const":"hr_reply"},{"const":"hr_request"},{"const":"onboarding"},{"const":"praise"},{"const":"product_updates"},{"const":"pulse"},{"const":"pulse_results"},{"const":"support_new"},{"const":"support_reply"}]}},"title":{"anyOf":[{"const":"From Shuffl"},{"const":"Programs"},{"const":"Requests and support"}]}},"required":["id","kinds","title"],"additionalProperties":false}},"preferences":{"type":"array","items":{"type":"object","properties":{"channels":{"type":"array","items":{"anyOf":[{"const":"email"},{"const":"slack"},{"const":"teams"}]}},"email":{"type":"boolean"},"kind":{"anyOf":[{"const":"billing_limit"},{"const":"celebration"},{"const":"connections_intro"},{"const":"hr_digest"},{"const":"hr_reply"},{"const":"hr_request"},{"const":"onboarding"},{"const":"praise"},{"const":"product_updates"},{"const":"pulse"},{"const":"pulse_results"},{"const":"support_new"},{"const":"support_reply"}]},"slack":{"type":"boolean"},"teams":{"type":"boolean"}},"required":["channels","email","kind","slack","teams"],"additionalProperties":false}},"slackLinked":{"type":"boolean"}},"required":["groups","preferences","slackLinked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"notifications.save"}},"/manage/onboarding/answerBuddyAsk":{"post":{"operationId":"onboarding.answerBuddyAsk","summary":"Say yes or not now to being a new hire’s onboarding buddy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"anyOf":[{"const":"accept"},{"const":"decline"}]},"askId":{"type":"string"},"confirm":{"const":"onboarding.answerBuddyAsk"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["answer","askId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"id":{"type":"string"},"status":{"type":"string"}},"required":["changed","id","status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.answerBuddyAsk"}},"/manage/onboarding/answerCheckIn":{"post":{"operationId":"onboarding.answerCheckIn","summary":"Answer your onboarding program’s help check-in: all good, or ask HR for help","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"anyOf":[{"const":"all_good"},{"const":"need_help"}]},"share":{"type":"object","properties":{"body":{"type":"string"},"conversationId":{"anyOf":[{"type":"null"},{"type":"string"}]},"destinationRevision":{"type":"number"},"requestId":{"type":"string"},"responderPersonIds":{"type":"array","items":{"type":"string"}},"sourceOwnerId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["body","destinationRevision","requestId","responderPersonIds"],"additionalProperties":false},"stepId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["answer","stepId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"answer":{"anyOf":[{"const":"all_good"},{"const":"need_help"}]},"caseId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["answer","caseId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.answerCheckIn"}},"/manage/onboarding/answerFirstDaysCheckIn":{"post":{"operationId":"onboarding.answerFirstDaysCheckIn","summary":"Answer your new-hire check-in","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string"},"question":{"type":"string"},"value":{"type":"number"}},"required":["question"],"additionalProperties":false}},"checkpoint":{"anyOf":[{"const":"day_30"},{"const":"day_365"},{"const":"day_60"},{"const":"day_90"}]},"confirm":{"const":"onboarding.answerFirstDaysCheckIn"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["answers","checkpoint","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"checkpoint":{"anyOf":[{"const":"day_30"},{"const":"day_365"},{"const":"day_60"},{"const":"day_90"}]},"commented":{"type":"boolean"}},"required":["checkpoint","commented"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.answerFirstDaysCheckIn"}},"/manage/onboarding/approve":{"post":{"operationId":"onboarding.approve","summary":"Approve these exact onboarding messages for sending","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enrollmentId":{"type":"string"},"expectedRevision":{"type":"number"},"previewHash":{"type":"string"},"confirm":{"const":"onboarding.approve"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["enrollmentId","expectedRevision","previewHash","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"approved":{"type":"number"},"revision":{"type":"number"}},"required":["approved","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.approve"}},"/manage/onboarding/askBuddy":{"post":{"operationId":"onboarding.askBuddy","summary":"Ask this coworker to be your onboarding buddy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string"},"personId":{"type":"string"},"confirm":{"const":"onboarding.askBuddy"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"personId":{"type":"string"},"status":{"const":"already_asked"}},"required":["personId","status"],"additionalProperties":false},{"type":"object","properties":{"personId":{"type":"string"},"status":{"const":"asked"}},"required":["personId","status"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.askBuddy"}},"/manage/onboarding/assignBuddy":{"post":{"operationId":"onboarding.assignBuddy","summary":"Assign an onboarding buddy to a new hire","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"buddyPersonId":{"type":"string"},"enrollmentId":{"type":"string"},"expectedRevision":{"type":"number"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["buddyPersonId","enrollmentId","expectedRevision","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"invitationId":{"type":"string"},"revision":{"type":"number"}},"required":["invitationId","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.assignBuddy"}},"/manage/onboarding/buddySuggestions":{"post":{"operationId":"onboarding.buddySuggestions","summary":"Suggest coworkers who could be your onboarding buddy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"asksLeft":{"type":"number"},"buddy":{"type":"null"},"linked":{"const":false},"suggestions":{"type":"array","items":{"type":"object","properties":{"ask":{"anyOf":[{"type":"null"},{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reasons":{"type":"array","items":{"type":"string"}},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["ask","id","name","photoUrl","reasons","slackUserId","title","userId"],"additionalProperties":false}}},"required":["asksLeft","buddy","linked","suggestions"],"additionalProperties":false},{"type":"object","properties":{"asksLeft":{"type":"number"},"buddy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"linked":{"const":true},"suggestions":{"type":"array","items":{"type":"object","properties":{"ask":{"anyOf":[{"type":"null"},{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]},"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reasons":{"type":"array","items":{"type":"string"}},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["ask","id","name","photoUrl","reasons","slackUserId","title","userId"],"additionalProperties":false}}},"required":["asksLeft","buddy","linked","suggestions"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.buddySuggestions"}},"/manage/onboarding/candidates":{"post":{"operationId":"onboarding.candidates","summary":"List people who could be enrolled in onboarding","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employment":{"anyOf":[{"const":"employed"},{"const":"ended"},{"const":"on_leave"},{"const":"unknown"}]},"id":{"type":"string"},"name":{"type":"string"},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["email","employment","id","name","startDate","timezone"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.candidates"}},"/manage/onboarding/enroll":{"post":{"operationId":"onboarding.enroll","summary":"Enroll this person in onboarding","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fingerprint":{"type":"string"},"programId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128},"rows":{"type":"array","items":{"type":"object","properties":{"buddyEmail":{"anyOf":[{"type":"null"},{"type":"string"}]},"buddyPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]}},"additionalProperties":false}},"confirm":{"const":"onboarding.enroll"}},"required":["fingerprint","programId","requestKey","rows","confirm"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"enrolled":{"type":"array","items":{"type":"object","properties":{"enrollmentId":{"type":"string"},"episode":{"type":"number"},"personId":{"type":"string"}},"required":["enrollmentId","episode","personId"],"additionalProperties":false}},"replayed":{"type":"boolean"},"skipped":{"type":"array","items":{"type":"number"}}},"required":["enrolled","replayed","skipped"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.enroll"}},"/manage/onboarding/enrollmentPreview":{"post":{"operationId":"onboarding.enrollmentPreview","summary":"Preview enrolling a new hire in onboarding","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enrollmentId":{"type":"string"}},"required":["enrollmentId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enrollmentId":{"type":"string"},"hash":{"type":"string"},"revision":{"type":"number"},"steps":{"type":"array","items":{"type":"object","properties":{"dueAt":{"type":"string","format":"date-time"},"kind":{"anyOf":[{"const":"buddy_invitation"},{"const":"check_in"},{"const":"introduction"}]},"offsetDays":{"type":"number"},"pending":{"type":"boolean"},"preview":{"type":"string"},"status":{"anyOf":[{"type":"null"},{"const":"accepted"},{"const":"answered"},{"const":"canceled"},{"const":"declined"},{"const":"failed"},{"const":"needs_review"},{"const":"opened"},{"const":"scheduled"},{"const":"sent"},{"const":"unknown"},{"const":"waiting"}]}},"required":["dueAt","kind","offsetDays","pending","preview","status"],"additionalProperties":false}}},"required":["enrollmentId","hash","revision","steps"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.enrollmentPreview"}},"/manage/onboarding/firstDaysCheckIns":{"post":{"operationId":"onboarding.firstDaysCheckIns","summary":"Your open 30, 60 or 90-day or one-year new hire check-in","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"checkpoint":{"anyOf":[{"const":"day_30"},{"const":"day_365"},{"const":"day_60"},{"const":"day_90"}]},"closesAt":{"type":"string","format":"date-time"},"questions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"kind":{"const":"scale"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"nps_11"},{"const":"rating_5"},{"const":"yes_no"}]},"text":{"type":"string"}},"required":["id","kind","scale","text"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"kind":{"const":"open"},"text":{"type":"string"}},"required":["id","kind","text"],"additionalProperties":false}]}},"title":{"type":"string"}},"required":["checkpoint","closesAt","questions","title"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.firstDaysCheckIns"}},"/manage/onboarding/firstDaysResults":{"post":{"operationId":"onboarding.firstDaysResults","summary":"What new hires said in their first 90 days check-ins, combined","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"checkpoints":{"type":"array","items":{"type":"object","properties":{"answered":{"type":"number"},"checkpoint":{"anyOf":[{"const":"day_30"},{"const":"day_365"},{"const":"day_60"},{"const":"day_90"}]},"label":{"type":"string"},"published":{"type":"boolean"},"questions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"answers":{"type":"array","items":{"type":"string"}},"favourable":{"not":{}},"id":{"type":"string"},"kind":{"const":"open"},"text":{"type":"string"}},"required":["answers","id","kind","text"],"additionalProperties":false},{"type":"object","properties":{"answers":{"not":{}},"favourable":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"kind":{"const":"scale"},"text":{"type":"string"}},"required":["favourable","id","kind","text"],"additionalProperties":false}]}},"sent":{"type":"number"}},"required":["answered","checkpoint","label","published","questions","sent"],"additionalProperties":false}},"floor":{"type":"number"},"manager":{"type":"object","properties":{"booked":{"type":"number"},"sent":{"type":"number"}},"required":["booked","sent"],"additionalProperties":false}},"required":["checkpoints","floor","manager"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.firstDaysResults"}},"/manage/onboarding/mine":{"post":{"operationId":"onboarding.mine","summary":"Read your own onboarding plan and buddy asks","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"buddyAsks":{"type":"array","items":{"not":{}}},"buddyName":{"type":"null"},"checkIns":{"type":"array","items":{"not":{}}},"enrolled":{"type":"boolean"},"invitations":{"type":"array","items":{"not":{}}},"myAsks":{"type":"array","items":{"not":{}}},"personId":{"type":"null"}},"required":["buddyAsks","buddyName","checkIns","enrolled","invitations","myAsks","personId"],"additionalProperties":false},{"type":"object","properties":{"buddyAsks":{"type":"array","items":{"type":"object","properties":{"hireName":{"type":"string"},"hirePersonId":{"type":"string"},"id":{"type":"string"},"status":{"anyOf":[{"const":"accepted"},{"const":"pending"}]}},"required":["hireName","hirePersonId","id","status"],"additionalProperties":false}},"buddyName":{"anyOf":[{"type":"null"},{"type":"string"}]},"checkIns":{"type":"array","items":{"type":"object","properties":{"answer":{"anyOf":[{"type":"null"},{"const":"all_good"},{"const":"need_help"}]},"answeredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"buddyName":{"anyOf":[{"type":"null"},{"type":"string"}]},"dueAt":{"type":"string","format":"date-time"},"enrollmentId":{"type":"string"},"programName":{"type":"string"},"status":{"anyOf":[{"const":"accepted"},{"const":"answered"},{"const":"canceled"},{"const":"declined"},{"const":"failed"},{"const":"needs_review"},{"const":"opened"},{"const":"scheduled"},{"const":"sent"},{"const":"unknown"},{"const":"waiting"}]},"stepId":{"type":"string"}},"required":["answer","answeredAt","buddyName","dueAt","enrollmentId","programName","status","stepId"],"additionalProperties":false}},"enrolled":{"type":"boolean"},"invitations":{"type":"array","items":{"type":"object","properties":{"hireName":{"type":"string"},"id":{"type":"string"},"programName":{"type":"string"},"startDate":{"type":"string"},"status":{"anyOf":[{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]}},"required":["hireName","id","programName","startDate","status"],"additionalProperties":false}},"myAsks":{"type":"array","items":{"type":"object","properties":{"buddyName":{"type":"string"},"buddyPersonId":{"type":"string"},"id":{"type":"string"},"status":{"anyOf":[{"const":"declined"},{"const":"pending"}]}},"required":["buddyName","buddyPersonId","id","status"],"additionalProperties":false}},"personId":{"type":"string"}},"required":["buddyAsks","buddyName","checkIns","enrolled","invitations","myAsks","personId"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.mine"}},"/manage/onboarding/person":{"post":{"operationId":"onboarding.person","summary":"Read a new hire's onboarding plan","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"buddyTo":{"type":"array","items":{"type":"object","properties":{"enrollmentId":{"type":"string"},"hire":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"invitation":{"anyOf":[{"type":"null"},{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]},"programId":{"type":"string"},"programName":{"type":"string"},"startDate":{"type":"string"}},"required":["enrollmentId","hire","invitation","programId","programName","startDate"],"additionalProperties":false}},"enrollments":{"type":"array","items":{"type":"object","properties":{"buddy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"enrollmentId":{"type":"string"},"invitation":{"anyOf":[{"type":"null"},{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]},"programId":{"type":"string"},"programName":{"type":"string"},"revision":{"type":"number"},"startDate":{"type":"string"}},"required":["buddy","enrollmentId","invitation","programId","programName","revision","startDate"],"additionalProperties":false}}},"required":["buddyTo","enrollments"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.person"}},"/manage/onboarding/previewEnrollment":{"post":{"operationId":"onboarding.previewEnrollment","summary":"Preview the onboarding steps for a new hire","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"programId":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"buddyEmail":{"anyOf":[{"type":"null"},{"type":"string"}]},"buddyPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]}},"additionalProperties":false}},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["programId","rows","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"fingerprint":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"buddyName":{"anyOf":[{"type":"null"},{"type":"string"}]},"buddyPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"index":{"type":"number"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"anyOf":[{"type":"null"},{"type":"string"}]},"problems":{"type":"array","items":{"anyOf":[{"const":"already_enrolled"},{"const":"ambiguous_email"},{"const":"buddy_ambiguous_email"},{"const":"buddy_employment_ended"},{"const":"buddy_is_hire"},{"const":"buddy_no_match"},{"const":"duplicate_row"},{"const":"employment_ended"},{"const":"invalid_timezone"},{"const":"missing_start_date"},{"const":"no_match"}]}},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"warnings":{"type":"array","items":{"anyOf":[{"const":"access_pending"},{"const":"buddy_no_slack_identity"},{"const":"no_buddy"},{"const":"no_slack_identity"}]}}},"required":["buddyName","buddyPersonId","email","index","name","personId","problems","startDate","timezone","warnings"],"additionalProperties":false}}},"required":["fingerprint","rows"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.previewEnrollment"}},"/manage/onboarding/program":{"post":{"operationId":"onboarding.program","summary":"Read the Onboarding program settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"programId":{"type":"string"}},"required":["programId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"buddyInvitation":{"type":"string"},"buddyOffsetDays":{"type":"number"},"checkIn":{"type":"string"},"checkInOffsetDays":{"type":"number"},"introductionOffsetDays":{"type":"number"},"responderPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendTime":{"type":"string"},"timezone":{"type":"string"}},"required":["buddyInvitation","buddyOffsetDays","checkIn","checkInOffsetDays","introductionOffsetDays","responderPersonId","sendTime","timezone"],"additionalProperties":false},"intro":{"type":"string"},"program":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"revision":{"type":"number"},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"}]}},"required":["id","name","revision","status"],"additionalProperties":false},"responderName":{"anyOf":[{"type":"null"},{"type":"string"}]},"rows":{"type":"array","items":{"type":"object","properties":{"approvedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"buddy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"invitation":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"respondedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"declined"},{"const":"pending"},{"const":"withdrawn"}]}},"required":["id","respondedAt","status"],"additionalProperties":false}]},"name":{"type":"string"}},"required":["id","invitation","name"],"additionalProperties":false}]},"episode":{"type":"number"},"id":{"type":"string"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"removalReason":{"anyOf":[{"type":"null"},{"const":"access_suspended"},{"const":"administrator"},{"const":"employment_ended"}]},"revision":{"type":"number"},"startDate":{"type":"string"},"status":{"anyOf":[{"const":"active"},{"const":"completed"},{"const":"removed"}]},"steps":{"type":"array","items":{"type":"object","properties":{"answer":{"anyOf":[{"type":"null"},{"const":"all_good"},{"const":"need_help"}]},"answeredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"deliveries":{"type":"array","items":{"type":"object","properties":{"attempts":{"type":"number"},"component":{"anyOf":[{"const":"bio"},{"const":"bio_invite"},{"const":"channel_notice"},{"const":"email"},{"const":"intro"},{"const":"open"}]},"errorCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"state":{"anyOf":[{"const":"attempting"},{"const":"canceled"},{"const":"failed"},{"const":"pending"},{"const":"sent"},{"const":"unknown"}]}},"required":["attempts","component","errorCode","id","state"],"additionalProperties":false}},"dueAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"errorCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"followUp":{"anyOf":[{"type":"null"},{"type":"object","properties":{"owned":{"type":"boolean"},"resolvedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"status":{"type":"string"}},"required":["owned","resolvedAt","status"],"additionalProperties":false}]},"id":{"type":"string"},"kind":{"anyOf":[{"const":"buddy_invitation"},{"const":"check_in"},{"const":"follow_up"},{"const":"introduction"}]},"offsetDays":{"type":"number"},"sentAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"status":{"anyOf":[{"const":"accepted"},{"const":"answered"},{"const":"canceled"},{"const":"declined"},{"const":"failed"},{"const":"needs_review"},{"const":"opened"},{"const":"scheduled"},{"const":"sent"},{"const":"unknown"},{"const":"waiting"}]}},"required":["answer","answeredAt","deliveries","dueAt","errorCode","followUp","id","kind","offsetDays","sentAt","status"],"additionalProperties":false}},"timezone":{"type":"string"}},"required":["approvedAt","buddy","episode","id","person","removalReason","revision","startDate","status","steps","timezone"],"additionalProperties":false}}},"required":["config","intro","program","responderName","rows"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"onboarding.program"}},"/manage/onboarding/remove":{"post":{"operationId":"onboarding.remove","summary":"Remove a new hire from onboarding","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enrollmentId":{"type":"string"},"expectedRevision":{"type":"number"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["enrollmentId","expectedRevision","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revision":{"type":"number"}},"required":["revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.remove"}},"/manage/onboarding/respondBuddy":{"post":{"operationId":"onboarding.respondBuddy","summary":"Accept or decline being an onboarding buddy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"invitationId":{"type":"string"},"response":{"anyOf":[{"const":"accept"},{"const":"decline"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["invitationId","response","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"status":{"type":"string"}},"required":["status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.respondBuddy"}},"/manage/onboarding/retry":{"post":{"operationId":"onboarding.retry","summary":"Retry a failed onboarding step","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stepId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["stepId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"status":{"const":"scheduled"}},"required":["status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.retry"}},"/manage/onboarding/saveProgram":{"post":{"operationId":"onboarding.saveProgram","summary":"Save the onboarding program and its messages","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"draft":{"anyOf":[{"const":false},{"const":true}]},"expectedRevision":{"type":"number"},"id":{"type":"string"},"program":{"type":"object","properties":{"intro":{"type":"string"},"name":{"type":"string"},"onboarding":{"type":"object","properties":{"buddyInvitation":{"type":"string"},"buddyOffsetDays":{"type":"number"},"checkIn":{"type":"string"},"checkInOffsetDays":{"type":"number"},"introductionOffsetDays":{"type":"number"},"responderPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendTime":{"type":"string"},"timezone":{"type":"string"}},"required":["buddyInvitation","buddyOffsetDays","checkIn","checkInOffsetDays","introductionOffsetDays","responderPersonId","sendTime","timezone"],"additionalProperties":false}},"required":["intro","name","onboarding"],"additionalProperties":false},"confirm":{"const":"onboarding.saveProgram"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["program","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string"},"kind":{"anyOf":[{"const":"introductions"},{"const":"onboarding"}]},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"anyOf":[{"const":"cross-unit"},{"const":"group-frequency-weighted"},{"const":"group-frequency-weighted-v2"},{"const":"hosted"},{"const":"new-connections"},{"const":"random"},{"const":"unit-lottery-weighted"},{"const":"unit-weighted"},{"const":"unit-weighted-multiple-hosts-per-group"},{"const":"unit-weighted-one-host-per-group"},{"const":"within-unit"}]},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"matchingReviewRequired":{"type":"boolean"},"name":{"type":"string"},"nextRunAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"onboarding":{"anyOf":[{"type":"null"},{"type":"object","properties":{"buddyInvitation":{"type":"string"},"buddyOffsetDays":{"type":"number"},"checkIn":{"type":"string"},"checkInOffsetDays":{"type":"number"},"introductionOffsetDays":{"type":"number"},"responderPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendTime":{"type":"string"},"timezone":{"type":"string"}},"required":["buddyInvitation","buddyOffsetDays","checkIn","checkInOffsetDays","introductionOffsetDays","responderPersonId","sendTime","timezone"],"additionalProperties":false}]},"revision":{"type":"number"},"rosterSyncedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string"},"frequency":{"anyOf":[{"const":"days"},{"const":"hours"},{"const":"minutes"},{"const":"monthly-date"},{"const":"monthly-last-weekday"},{"const":"monthly-weekday"},{"const":"weeks"}]},"interval":{"type":"number"},"timezone":{"type":"string"}},"required":["anchor","frequency","interval","timezone"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"type":"string"},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"source-pending"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","timezone","version"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"anyOf":[{"type":"null"},{"type":"string"}]},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"operator-future-start"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","origin","timezone","version"],"additionalProperties":false}]},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"}]},"teamId":{"type":"string"}},"required":["channelId","channelName","createdAt","id","includeBios","includeSchedulingLink","intro","kind","match","matchingReviewRequired","name","nextRunAt","onboarding","revision","rosterSyncedAt","schedule","status","teamId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.saveProgram"}},"/manage/onboarding/update":{"post":{"operationId":"onboarding.update","summary":"Change a new hire's onboarding start date or time zone","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enrollmentId":{"type":"string"},"expectedRevision":{"type":"number"},"startDate":{"type":"string"},"timezone":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["enrollmentId","expectedRevision","startDate","timezone","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revision":{"type":"number"},"stepsReturnedToReview":{"type":"number"}},"required":["revision","stepsReturnedToReview"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"onboarding.update"}},"/manage/operations/activity":{"post":{"operationId":"operations.activity","summary":"Read the workspace's recent audit activity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"actorName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true}]}},"entityId":{"anyOf":[{"type":"null"},{"type":"string"}]},"entityName":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"teamId":{"type":"string"}},"required":["action","actorId","actorName","createdAt","details","entityId","entityName","id","teamId"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"operations.activity"}},"/manage/operations/dispatchInbox":{"post":{"operationId":"operations.dispatchInbox","summary":"Resume already-admitted team provider events and support delivery","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"operations.dispatchInbox"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"workflowId":{"type":"string"}},"required":["workflowId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"operations.dispatchInbox"}},"/manage/operations/reconcile":{"post":{"operationId":"operations.reconcile","summary":"Reconcile an externally verified delivery outcome","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deliveryId":{"type":"string"},"outcome":{"anyOf":[{"const":"confirmed_absent"},{"const":"confirmed_sent"}]},"reason":{"type":"string"},"receipt":{"type":"string"},"confirm":{"const":"operations.reconcile"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["deliveryId","outcome","reason","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"reconciled":{"type":"boolean"}},"required":["reconciled"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"operations.reconcile"}},"/manage/operations/status":{"post":{"operationId":"operations.status","summary":"Read the workspace delivery and provider health summary","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"inbound":{"type":"array","items":{"type":"object","properties":{"errorCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"provider":{"type":"string"},"status":{"anyOf":[{"const":"failed"},{"const":"processed"},{"const":"queued"}]}},"required":["errorCode","id","provider","status"],"additionalProperties":false}},"unknown":{"type":"array","items":{"type":"object","properties":{"code":{"anyOf":[{"type":"null"},{"type":"string"}]},"component":{"anyOf":[{"const":"bio"},{"const":"bio_invite"},{"const":"channel_notice"},{"const":"email"},{"const":"intro"},{"const":"open"}]},"id":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["code","component","id","updatedAt"],"additionalProperties":false}}},"required":["inbound","unknown"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"operations.status"}},"/manage/praise/addChannel":{"post":{"operationId":"praise.addChannel","summary":"Read praise from this Slack channel from now on","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string"},"confirm":{"const":"praise.addChannel"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"added":{"type":"boolean"},"channelId":{"type":"string"}},"required":["added","channelId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.addChannel"}},"/manage/praise/composer":{"post":{"operationId":"praise.composer","summary":"Read who you can praise, the praise channels and company values","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"blocked":{"anyOf":[{"type":"null"},{"const":"no_channel"},{"const":"no_slack"},{"const":"not_linked"},{"const":"off"}]},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"people":{"type":"array","items":{"not":{}}},"suggestions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","reason","title"],"additionalProperties":false}},"values":{"type":"array","items":{"not":{}}}},"required":["blocked","channels","people","suggestions","values"],"additionalProperties":false},{"type":"object","properties":{"blocked":{"type":"null"},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","title"],"additionalProperties":false}},"suggestions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","reason","title"],"additionalProperties":false}},"values":{"type":"array","items":{"type":"string"}}},"required":["blocked","channels","people","suggestions","values"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.composer"}},"/manage/praise/feed":{"post":{"operationId":"praise.feed","summary":"Read the Praise feed","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"before":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]},"limit":{"type":"number"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"channelPrivate":{"type":"boolean"},"giver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"id":{"type":"string"},"postedAt":{"type":"string","format":"date-time"},"reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"emoji":{"type":"string"}},"required":["count","emoji"],"additionalProperties":false}},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"hidden":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["hidden","id","name"],"additionalProperties":false}},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["channelId","channelName","channelPrivate","giver","id","postedAt","reactions","reason","recipients","slackUrl","text","values"],"additionalProperties":false}},"next":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["items","next"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.feed"}},"/manage/praise/insights":{"post":{"operationId":"praise.insights","summary":"Read Praise totals by value (groups of seven or more)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"required":["days"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"type":"number"},"crossDepartmentShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"days":{"anyOf":[{"const":30},{"const":90}]},"departments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"recognizedShare":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["name","recognizedShare"],"additionalProperties":false}},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"givingShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"praise":{"anyOf":[{"type":"null"},{"type":"number"}]},"recognizedShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"values":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"value":{"type":"string"}},"required":["count","value"],"additionalProperties":false}},"weeks":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"week":{"type":"string"}},"required":["count","week"],"additionalProperties":false}}},"required":["audience","crossDepartmentShare","days","departments","floor","floorMet","givingShare","praise","recognizedShare","values","weeks"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.insights"}},"/manage/praise/mine":{"post":{"operationId":"praise.mine","summary":"Read praise you gave and received","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"digest":{"type":"boolean"},"given":{"type":"array","items":{"not":{}}},"linked":{"type":"boolean"},"personId":{"not":{}},"received":{"type":"array","items":{"not":{}}}},"required":["digest","given","linked","received"],"additionalProperties":false},{"type":"object","properties":{"digest":{"type":"boolean"},"given":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"channelPrivate":{"type":"boolean"},"giver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"id":{"type":"string"},"postedAt":{"type":"string","format":"date-time"},"reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"emoji":{"type":"string"}},"required":["count","emoji"],"additionalProperties":false}},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"hidden":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["hidden","id","name"],"additionalProperties":false}},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["channelId","channelName","channelPrivate","giver","id","postedAt","reactions","reason","recipients","slackUrl","text","values"],"additionalProperties":false}},"linked":{"type":"boolean"},"personId":{"type":"string"},"received":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"channelPrivate":{"type":"boolean"},"giver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"id":{"type":"string"},"postedAt":{"type":"string","format":"date-time"},"reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"emoji":{"type":"string"}},"required":["count","emoji"],"additionalProperties":false}},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"hidden":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["hidden","id","name"],"additionalProperties":false}},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["channelId","channelName","channelPrivate","giver","id","postedAt","reactions","reason","recipients","slackUrl","text","values"],"additionalProperties":false}}},"required":["digest","given","linked","personId","received"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.mine"}},"/manage/praise/ofPerson":{"post":{"operationId":"praise.ofPerson","summary":"Read the public praise one person received","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"channelPrivate":{"type":"boolean"},"giver":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"id":{"type":"string"},"postedAt":{"type":"string","format":"date-time"},"reactions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"emoji":{"type":"string"}},"required":["count","emoji"],"additionalProperties":false}},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"hidden":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["hidden","id","name"],"additionalProperties":false}},"slackUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["channelId","channelName","channelPrivate","giver","id","postedAt","reactions","reason","recipients","slackUrl","text","values"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.ofPerson"}},"/manage/praise/removeChannel":{"post":{"operationId":"praise.removeChannel","summary":"Stop reading praise from a Slack channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string"},"confirm":{"const":"praise.removeChannel"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"removed":{"type":"boolean"}},"required":["removed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.removeChannel"}},"/manage/praise/saveSettings":{"post":{"operationId":"praise.saveSettings","summary":"Save the Praise settings and company values","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"reaction":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"off"},{"const":"on"}]},"valuesSourceId":{"anyOf":[{"type":"null"},{"type":"string"}]},"confirm":{"const":"praise.saveSettings"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","status","valuesSourceId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"revision":{"type":"number"}},"required":["changed","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.saveSettings"}},"/manage/praise/send":{"post":{"operationId":"praise.send","summary":"Praise coworkers in a praise channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string"},"composerKey":{"type":"string"},"from":{"anyOf":[{"const":"feed"},{"const":"nudge"},{"const":"profile"},{"const":"suggestion"},{"const":"yours"}]},"recipientIds":{"type":"array","items":{"type":"string"}},"text":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"confirm":{"const":"praise.send"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","composerKey","recipientIds","text","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"channelId":{"type":"string"},"praiseId":{"type":"string"},"recipients":{"type":"number"},"replayed":{"type":"boolean"}},"required":["channelId","praiseId","recipients","replayed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.send"}},"/manage/praise/setDigest":{"post":{"operationId":"praise.setDigest","summary":"Choose whether you get the daily Praise digest","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"digest":{"type":"boolean"},"confirm":{"const":"praise.setDigest"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["digest","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"digest":{"type":"boolean"}},"required":["digest"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.setDigest"}},"/manage/praise/setHidden":{"post":{"operationId":"praise.setHidden","summary":"Hide or show a praise you received","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hidden":{"type":"boolean"},"praiseId":{"type":"string"},"confirm":{"const":"praise.setHidden"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["hidden","praiseId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"hidden":{"type":"boolean"}},"required":["hidden"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"praise.setHidden"}},"/manage/praise/settings":{"post":{"operationId":"praise.settings","summary":"Read the Praise settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean"},"addedAt":{"type":"string","format":"date-time"},"channelId":{"type":"string"},"channelName":{"type":"string"},"importError":{"anyOf":[{"type":"null"},{"type":"string"}]},"imported":{"type":"number"},"importedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"importStatus":{"anyOf":[{"const":"done"},{"const":"failed"},{"const":"pending"},{"const":"running"}]},"introError":{"anyOf":[{"type":"null"},{"type":"string"}]},"introPostedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"isPrivate":{"type":"boolean"},"reading":{"type":"number"}},"required":["active","addedAt","channelId","channelName","importError","imported","importedAt","importStatus","introError","introPostedAt","isPrivate","reading"],"additionalProperties":false}},"companyValues":{"type":"array","items":{"type":"string"}},"praiseCount":{"type":"number"},"reaction":{"anyOf":[{"type":"null"},{"type":"string"}]},"reactionError":{"anyOf":[{"type":"null"},{"type":"string"}]},"reactionReadScope":{"type":"boolean"},"reactionScope":{"type":"boolean"},"revision":{"type":"number"},"status":{"anyOf":[{"const":"off"},{"const":"on"}]},"valuesPages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"published":{"type":"boolean"},"title":{"type":"string"}},"required":["id","published","title"],"additionalProperties":false}},"valuesSource":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"published":{"type":"boolean"},"title":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["id","published","title","values"],"additionalProperties":false}]},"valuesSourceId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["channels","companyValues","praiseCount","reaction","reactionError","reactionReadScope","reactionScope","revision","status","valuesPages","valuesSource","valuesSourceId"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"praise.settings"}},"/manage/profiles/cover/delete":{"post":{"operationId":"profiles.cover.delete","summary":"Remove your profile cover picture","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.cover.delete"}},"/manage/profiles/draft":{"post":{"operationId":"profiles.draft","summary":"Draft the empty parts of your own profile with Mello; nothing is saved","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"confirm":{"const":"profiles.draft"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"bio":{"anyOf":[{"type":"null"},{"type":"string"}]},"by":{"anyOf":[{"const":"ai"},{"const":"rule"}]},"interests":{"anyOf":[{"type":"null"},{"type":"string"}]},"offers":{"anyOf":[{"type":"null"},{"type":"string"}]},"workingOn":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["askMeAbout","bio","by","interests","offers","workingOn"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.draft"}},"/manage/profiles/employeeNumber":{"post":{"operationId":"profiles.employeeNumber","summary":"Set a person’s employee number to an unused number","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employeeNumber":{"type":"number"},"personId":{"type":"string"},"confirm":{"const":"profiles.employeeNumber"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["employeeNumber","personId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.employeeNumber"}},"/manage/profiles/get":{"post":{"operationId":"profiles.get","summary":"Read a person’s profile as this team sees it","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"viewAs":{"anyOf":[{"const":"other"},{"const":"team"}]}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"about":{"type":"object","properties":{"askMeAbout":{"anyOf":[{"type":"null"},{"type":"array","items":{"type":"string"}}]},"asks":{"anyOf":[{"type":"null"},{"type":"string"}]},"bio":{"anyOf":[{"type":"null"},{"type":"string"}]},"interests":{"anyOf":[{"type":"null"},{"type":"string"}]},"location":{"anyOf":[{"type":"null"},{"type":"string"}]},"offers":{"anyOf":[{"type":"null"},{"type":"string"}]},"phone":{"anyOf":[{"type":"null"},{"type":"string"}]},"pronouns":{"anyOf":[{"type":"null"},{"type":"string"}]},"workingOn":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["askMeAbout","asks","bio","interests","location","offers","phone","pronouns","workingOn"],"additionalProperties":false},"birthday":{"anyOf":[{"type":"null"},{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"}},"required":["day","month"],"additionalProperties":false}]},"buddy":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}]},"canEdit":{"type":"boolean"},"canManage":{"type":"boolean"},"knows":{"anyOf":[{"type":"null"},{"type":"number"}]},"links":{"anyOf":[{"type":"null"},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"url":{"type":"string"}},"required":["id","label","url"],"additionalProperties":false}}]},"managers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"person":{"type":"object","properties":{"coverUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"department":{"anyOf":[{"type":"null"},{"type":"string"}]},"departmentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"joinedAfterPercent":{"anyOf":[{"type":"null"},{"type":"number"}]},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"teams":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"uploadedPhoto":{"type":"boolean"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["coverUrl","department","departmentId","email","employeeNumber","id","joinedAfterPercent","name","photoUrl","slackUserId","startDate","teams","timezone","title","uploadedPhoto","userId"],"additionalProperties":false},"positions":{"anyOf":[{"type":"null"},{"type":"array","items":{"type":"object","properties":{"endedOn":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"organization":{"anyOf":[{"type":"null"},{"type":"string"}]},"source":{"anyOf":[{"const":"admin"},{"const":"directory"},{"const":"person"}]},"startedOn":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"},"unitName":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["endedOn","id","organization","source","startedOn","title","unitName"],"additionalProperties":false}}]},"preview":{"anyOf":[{"type":"null"},{"const":"other"},{"const":"team"}]},"relation":{"anyOf":[{"const":"other"},{"const":"self"},{"const":"team"}]},"reports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}},"self":{"type":"boolean"},"settings":{"anyOf":[{"type":"null"},{"type":"object","properties":{"about":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"badges":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"birthday":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"buddy":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"links":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"location":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"network":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"phone":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"pronouns":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]}},"required":["about","badges","birthday","buddy","links","location","network","phone","pronouns"],"additionalProperties":false}]},"teammates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title","userId"],"additionalProperties":false}}},"required":["about","birthday","buddy","canEdit","canManage","knows","links","managers","person","positions","preview","relation","reports","self","settings","teammates"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"profiles.get"}},"/manage/profiles/photo/delete":{"post":{"operationId":"profiles.photo.delete","summary":"Remove your profile photo","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.photo.delete"}},"/manage/profiles/positions/delete":{"post":{"operationId":"profiles.positions.delete","summary":"Remove a past position from your profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"},"positionId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["personId","positionId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.positions.delete"}},"/manage/profiles/positions/save":{"post":{"operationId":"profiles.positions.save","summary":"Add or change a past position on your profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endedOn":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"organization":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"},"startedOn":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"},"unitName":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["endedOn","organization","personId","startedOn","title","unitName","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.positions.save"}},"/manage/profiles/save":{"post":{"operationId":"profiles.save","summary":"Save your own profile: pronouns, location, phone, bio, interests, links and what you are working on","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"links":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"required":["label","url"],"additionalProperties":false}},"location":{"type":"string"},"offers":{"type":"string"},"personId":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"workingOn":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["links","personId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.save"}},"/manage/profiles/settings":{"post":{"operationId":"profiles.settings","summary":"Choose who sees the optional parts of your own profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"about":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"badges":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"birthday":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"buddy":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"links":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"location":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"network":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"personId":{"type":"string"},"phone":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"pronouns":{"anyOf":[{"const":"everyone"},{"const":"my_team"},{"const":"only_me"}]},"confirm":{"const":"profiles.settings"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["about","badges","links","location","network","personId","phone","pronouns","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"profiles.settings"}},"/manage/profiles/whoKnows":{"post":{"operationId":"profiles.whoKnows","summary":"Find coworkers who know about a topic, place or skill from what they share on their profiles, with the words that matched","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"number"},"personIds":{"type":"array","items":{"type":"string"}},"topic":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"people":{"type":"array","items":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"knowsYou":{"type":"boolean"},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","photoUrl","slackUserId","title"],"additionalProperties":false},"reasons":{"type":"array","items":{"type":"object","properties":{"field":{"anyOf":[{"const":"askMeAbout"},{"const":"bio"},{"const":"community"},{"const":"interests"},{"const":"location"},{"const":"offers"},{"const":"position"},{"const":"team"},{"const":"title"},{"const":"workingOn"}]},"label":{"type":"string"},"text":{"type":"string"}},"required":["field","label","text"],"additionalProperties":false}},"self":{"type":"boolean"}},"required":["askMeAbout","knowsYou","person","reasons","self"],"additionalProperties":false}},"total":{"type":"number"}},"required":["people","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"profiles.whoKnows"}},"/manage/programs/joinChannel":{"post":{"operationId":"programs.joinChannel","summary":"Add Shuffl to this public Slack channel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string"},"confirm":{"const":"programs.joinChannel"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"isMember":{"type":"boolean"},"isPrivate":{"type":"boolean"},"joinable":{"type":"boolean"},"memberCount":{"type":"number"},"name":{"type":"string"},"purpose":{"type":"string"},"readiness":{"anyOf":[{"const":"invite_required"},{"const":"missing_scope"},{"const":"ready"}]}},"required":["id","isMember","isPrivate","joinable","name","readiness"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.joinChannel"}},"/manage/programs/people":{"post":{"operationId":"programs.people","summary":"List the people in a program and whether they take part","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"programId":{"type":"string"}},"required":["programId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"state":{"anyOf":[{"const":"break"},{"const":"in"},{"const":"paused"},{"const":"unavailable"}]},"unavailable":{"anyOf":[{"type":"null"},{"const":"absent"},{"const":"access_unavailable"},{"const":"bot"},{"const":"inactive"},{"const":"slack_unavailable"}]}},"required":["id","name","photoUrl","state","unavailable"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.people"}},"/manage/programs/schedulePreview":{"post":{"operationId":"programs.schedulePreview","summary":"Preview a program's upcoming rounds","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"program":{"type":"object","properties":{"channelId":{"type":"string"},"channelName":{"type":"string"},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"anyOf":[{"const":false},{"const":true}]},"intro":{"type":"string"},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"anyOf":[{"const":"cross-unit"},{"const":"group-frequency-weighted"},{"const":"group-frequency-weighted-v2"},{"const":"hosted"},{"const":"new-connections"},{"const":"random"},{"const":"unit-lottery-weighted"},{"const":"unit-weighted"},{"const":"unit-weighted-multiple-hosts-per-group"},{"const":"unit-weighted-one-host-per-group"},{"const":"within-unit"}]},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string"},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string"},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"source-pending"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","timezone","version"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"anyOf":[{"type":"null"},{"type":"string"}]},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"operator-future-start"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","origin","timezone","version"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"type":"string"},"frequency":{"anyOf":[{"const":"days"},{"const":"hours"},{"const":"minutes"},{"const":"monthly-date"},{"const":"monthly-last-weekday"},{"const":"monthly-weekday"},{"const":"weeks"}]},"interval":{"type":"number"},"timezone":{"type":"string"}},"required":["anchor","frequency","interval","timezone"],"additionalProperties":false}]}},"required":["channelId","channelName","includeBios","intro","match","name","schedule"],"additionalProperties":false}},"required":["program"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"date-time"}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.schedulePreview"}},"/programs/{id}/archive":{"post":{"operationId":"programs.archive","summary":"Archive a program","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.archive"}},"/programs":{"post":{"operationId":"programs.create","summary":"Create a program; reuse requestKey only for the same request","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"draft":{"type":"boolean","default":true},"program":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]}},"required":["channelId","channelName","includeBios","intro","match","name","schedule"]},"requestKey":{"type":"string","minLength":8,"maxLength":120}},"required":["program","requestKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.create"},"get":{"operationId":"programs.list","summary":"List programs","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","minLength":1,"maxLength":128},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["items","nextCursor"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.list"}},"/programs/{id}":{"get":{"operationId":"programs.get","summary":"Get a program","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.get"},"put":{"operationId":"programs.update","summary":"Update a program at an expected revision","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"description":"The revision you read. When given, the update is refused if the program changed since."},"program":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"anyOf":[{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"additionalProperties":false},{"type":"null"}]},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"anyOf":[{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},{"type":"null"}]},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"anyOf":[{"enum":["department","team"],"type":"string"},{"type":"null"}]}},"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"additionalProperties":false,"description":"Only the fields to change. match, match.fineTune and schedule merge field by field; keepApart or fineTune null removes it."},"reviewMatching":{"type":"boolean"}},"required":["program"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.update"}},"/program-options":{"get":{"operationId":"programs.options","summary":"List the choices for a Connections program: who should meet whom, keep-apart rules, fine-tuning, defaults, teams and departments","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"defaults":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"strategy":{"const":"new-connections"}},"required":["fineTune","keepApart","strategy"]},"fineTune":{"type":"object","properties":{"commonGround":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"label":{"type":"string"},"value":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["label","value"]}},"meetRequests":{"type":"string"},"mentionCommonGround":{"type":"string"},"reach":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}}},"required":["commonGround","meetRequests","mentionCommonGround","reach"]},"keepApart":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}},"purposes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}},"units":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"kind":{"enum":["department","team"],"type":"string"},"name":{"type":"string"}},"required":["id","kind","name"]}}},"required":["defaults","fineTune","keepApart","purposes","units"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.options"}},"/programs/{id}/pause":{"post":{"operationId":"programs.pause","summary":"Pause a program","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.pause"}},"/programs/{id}/preview":{"post":{"operationId":"programs.preview","summary":"Preview matches without sending introductions","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"seed":{"type":"string","minLength":1,"maxLength":128}},"required":["seed"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"algorithm":{"type":"string"},"eligible":{"type":"number"},"exclusions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"enum":["bot","inactive","absent","paused","slack_unavailable","access_unavailable"],"type":"string"}},"required":["count","reason"]}},"fingerprint":{"type":"string"},"groups":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128}}},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string"}},"required":["id","name"]}},"newConnections":{"type":"number"},"pairWeight":{"type":"number"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"selected":{"type":"number"},"unmatched":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128}}},"required":["algorithm","eligible","exclusions","fingerprint","groups","members","newConnections","pairWeight","revision","selected","unmatched"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"programs.preview"}},"/programs/{id}/resume":{"post":{"operationId":"programs.resume","summary":"Activate a program and its schedule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[CG][A-Z0-9]+$"},"channelName":{"type":"string","minLength":1,"maxLength":100},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string","minLength":1,"maxLength":2000},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}],"description":"Shared interests and \"can help with\" / \"looking for\" topics pick between people who are equally new to each other. 0 off, 1 prefer, 2 strongly prefer."},"meetRequests":{"type":"boolean","description":"Group someone with a person they privately asked to meet, at most once per person per round. Nobody, including admins, is told who asked."},"mentionCommonGround":{"type":"boolean","description":"Name a topic both people show publicly on their profile in the introduction."},"reach":{"enum":["any","fof","far"],"type":"string","description":"any: anyone new. fof: friends of friends first (people in common). far: far corners first (nobody in common)."}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"integer","minimum":2,"maximum":8},"iterations":{"type":"integer","minimum":1,"maximum":1000},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["reporting-line","team","department","know-each-other"],"type":"string"}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"integer","minimum":2,"maximum":8},"strategy":{"enum":["new-connections","cross-unit","within-unit","hosted","random","group-frequency-weighted","group-frequency-weighted-v2","unit-weighted","unit-weighted-one-host-per-group","unit-weighted-multiple-hosts-per-group","unit-lottery-weighted"],"type":"string"},"unitIds":{"type":"array","maxItems":20,"items":{"type":"string","minLength":1,"maxLength":200}},"unitKind":{"enum":["department","team"],"type":"string"}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":120},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string","maxLength":100},"frequency":{"enum":["minutes","hours","days","weeks","monthly-date","monthly-weekday","monthly-last-weekday"],"type":"string"},"interval":{"type":"integer","minimum":1,"maximum":366},"timezone":{"type":"string","maxLength":100}},"required":["anchor","frequency","interval","timezone"]},{"anyOf":[{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"type":"string","format":"date-time"},"origin":{"const":"source-pending"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor"],"additionalProperties":false},{"type":"object","properties":{"calendar":{"type":"object","properties":{"boundary":{"enum":["start","end"],"type":"string"},"hour":{"type":"integer","minimum":0,"maximum":527},"minute":{"type":"integer","minimum":0,"maximum":59},"second":{"type":"integer","minimum":0,"maximum":59},"timezone":{"type":"string","minLength":1,"maxLength":100},"weekday":{"type":"integer","minimum":0,"maximum":6}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"timezone":{"type":"string","minLength":1,"maxLength":100},"version":{"const":1},"anchor":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"origin":{"const":"operator-future-start"}},"required":["calendar","frequency","insufficientOptInsNotice","interval","timezone","version","anchor","origin"],"additionalProperties":false}]}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"matchingReviewRequired":{"type":"boolean"},"nextRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"status":{"enum":["active","paused","archived"],"type":"string"},"summary":{"type":"string","description":"What the program does, in the same sentence the editor shows."},"teamId":{"type":"string","minLength":1,"maxLength":128}},"required":["channelId","channelName","includeBios","intro","match","name","schedule","createdAt","id","matchingReviewRequired","nextRunAt","revision","status","teamId"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.resume"}},"/programs/{id}/sync-roster":{"post":{"operationId":"programs.syncRoster","summary":"Refresh program channel membership","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"synced":{"type":"boolean"}},"required":["synced"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"programs.syncRoster"}},"/manage/pulse/actions":{"post":{"operationId":"pulse.actions","summary":"List Pulse actions: what is being done about each result, its owner, due date and before and after","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"sendId":{"type":"string"},"status":{"anyOf":[{"const":"all"},{"const":"open"},{"const":"overdue"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"object","properties":{"after":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"enps":{"anyOf":[{"type":"null"},{"type":"number"}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"invited":{"type":"number"},"open":{"type":"boolean"},"respondents":{"type":"number"},"scheduledFor":{"type":"string","format":"date-time"},"sendId":{"type":"string"}},"required":["answered","enps","favourablePct","floor","floorMet","invited","open","respondents","scheduledFor","sendId"],"additionalProperties":false}]},"before":{"type":"object","properties":{"answered":{"type":"number"},"enps":{"anyOf":[{"type":"null"},{"type":"number"}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"invited":{"type":"number"},"open":{"type":"boolean"},"respondents":{"type":"number"},"scheduledFor":{"type":"string","format":"date-time"},"sendId":{"type":"string"}},"required":["answered","enps","favourablePct","floor","floorMet","invited","open","respondents","scheduledFor","sendId"],"additionalProperties":false},"change":{"anyOf":[{"type":"null"},{"type":"number"}]},"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"createdAt":{"type":"string","format":"date-time"},"detail":{"anyOf":[{"type":"null"},{"type":"string"}]},"dueOn":{"type":"string"},"id":{"type":"string"},"overdue":{"type":"boolean"},"owner":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"post":{"type":"object","properties":{"channelName":{"anyOf":[{"type":"null"},{"type":"string"}]},"delivery":{"anyOf":[{"type":"null"},{"type":"object","properties":{"channel":{"anyOf":[{"type":"null"},{"const":"delivered"},{"const":"failed"},{"const":"held"},{"const":"pending"}]},"delivered":{"type":"number"},"failed":{"type":"number"},"held":{"type":"number"},"pending":{"type":"number"},"people":{"type":"number"}},"required":["channel","delivered","failed","held","pending","people"],"additionalProperties":false}]},"dms":{"type":"boolean"},"draftedBy":{"anyOf":[{"type":"null"},{"const":"ai"},{"const":"person"},{"const":"rule"}]},"postedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"text":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["channelName","delivery","dms","draftedBy","postedAt","text"],"additionalProperties":false},"question":{"type":"object","properties":{"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"scale":{"type":"string"},"sendId":{"type":"string"},"text":{"type":"string"}},"required":["audienceLabel","driver","driverLabel","scale","sendId","text"],"additionalProperties":false},"recheck":{"type":"object","properties":{"on":{"anyOf":[{"type":"null"},{"type":"string"}]},"state":{"anyOf":[{"const":"closed"},{"const":"off"},{"const":"open"},{"const":"waiting"}]}},"required":["on","state"],"additionalProperties":false},"revision":{"type":"number"},"status":{"anyOf":[{"const":"done"},{"const":"dropped"},{"const":"in_progress"},{"const":"planned"}]},"title":{"type":"string"}},"required":["after","before","change","completedAt","createdAt","detail","dueOn","id","overdue","owner","post","question","recheck","revision","status","title"],"additionalProperties":false}},"aiEnabled":{"type":"boolean"}},"required":["actions","aiEnabled"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.actions"}},"/manage/pulse/addQuestion":{"post":{"operationId":"pulse.addQuestion","summary":"Add a Pulse question to the library","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"type":"object","properties":{"departmentIds":{"type":"array","items":{"type":"string"}},"role":{"anyOf":[{"const":"everyone"},{"const":"ics"},{"const":"managers"}]},"teamIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"scale":{"anyOf":[{"const":"agree_5"},{"const":"rating_5"},{"const":"yes_no"}]},"text":{"type":"string"},"confirm":{"const":"pulse.addQuestion"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["driver","scale","text","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"targeted":{"type":"boolean"}},"required":["id","targeted"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.addQuestion"}},"/manage/pulse/addTemplate":{"post":{"operationId":"pulse.addTemplate","summary":"Add a Pulse question set from a template","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string"},"confirm":{"const":"pulse.addTemplate"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["templateId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"added":{"type":"number"}},"required":["added"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.addTemplate"}},"/manage/pulse/answer":{"post":{"operationId":"pulse.answer","summary":"Answer today’s Pulse question as yourself","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sendId":{"type":"string"},"value":{"type":"number"},"confirm":{"const":"pulse.answer"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["sendId","value","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"outcome":{"anyOf":[{"const":"closed"},{"const":"invalid"},{"const":"not_invited"},{"const":"recorded"}]}},"required":["outcome"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.answer"}},"/manage/pulse/asked":{"post":{"operationId":"pulse.asked","summary":"List the Pulse questions asked so far","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"closesAt":{"type":"string","format":"date-time"},"driver":{"type":"string"},"id":{"type":"string"},"questionText":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"status":{"anyOf":[{"const":"closed"},{"const":"open"}]}},"required":["closesAt","driver","id","questionText","scheduledFor","status"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.asked"}},"/manage/pulse/audienceOptions":{"post":{"operationId":"pulse.audienceOptions","summary":"List the departments and teams a Pulse question can be aimed at","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"departments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"people":{"type":"number"}},"required":["id","name","people"],"additionalProperties":false}},"floor":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"departmentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"manager":{"type":"boolean"},"teamIds":{"type":"array","items":{"type":"string"}}},"required":["departmentId","manager","teamIds"],"additionalProperties":false}},"teams":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"people":{"type":"number"}},"required":["id","name","people"],"additionalProperties":false}}},"required":["departments","floor","members","teams"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.audienceOptions"}},"/manage/pulse/createAction":{"post":{"operationId":"pulse.createAction","summary":"Plan an action about a closed Pulse question, with an owner and a due date","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"anyOf":[{"type":"null"},{"type":"string"}]},"dueOn":{"type":"string"},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"recheck":{"anyOf":[{"const":false},{"const":true}]},"sendId":{"type":"string"},"title":{"type":"string"},"confirm":{"const":"pulse.createAction"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["dueOn","sendId","title","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"id":{"type":"string"},"owner":{"type":"boolean"},"recheck":{"type":"boolean"}},"required":["driver","id","owner","recheck"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.createAction"}},"/manage/pulse/decideProposal":{"post":{"operationId":"pulse.decideProposal","summary":"Approve a suggested Pulse question so it is asked next, or dismiss it","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"anyOf":[{"const":"approve"},{"const":"reject"}]},"expectedRevision":{"type":"number"},"proposalId":{"type":"string"},"confirm":{"const":"pulse.decideProposal"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["decision","expectedRevision","proposalId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"decision":{"anyOf":[{"const":"approve"},{"const":"reject"}]},"edited":{"type":"boolean"},"id":{"type":"string"},"origin":{"anyOf":[{"const":"mello"},{"const":"requested"},{"const":"weekly"}]},"questionId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["decision","edited","id","origin","questionId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.decideProposal"}},"/manage/pulse/editProposal":{"post":{"operationId":"pulse.editProposal","summary":"Reword a suggested Pulse question before approving it","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"expectedRevision":{"type":"number"},"proposalId":{"type":"string"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"rating_5"},{"const":"yes_no"}]},"text":{"type":"string"},"confirm":{"const":"pulse.editProposal"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["driver","expectedRevision","proposalId","scale","text","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"checkReasons":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"revision":{"type":"number"}},"required":["checkReasons","id","revision"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.editProposal"}},"/manage/pulse/insights":{"post":{"operationId":"pulse.insights","summary":"Read Pulse totals and trends (groups of seven or more)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"answered":{"type":"number"},"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]},"drivers":{"type":"array","items":{"type":"object","properties":{"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"sends":{"type":"number"}},"required":["driver","favourablePct","label","respondents","sends"],"additionalProperties":false}},"enps":{"type":"object","properties":{"latest":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"distribution":{"anyOf":[{"type":"null"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"invited":{"type":"number"},"mean":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"respondents":{"type":"number"},"scale":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","audienceLabel","closedAt","distribution","driver","driverLabel","enps","favourablePct","floor","floorMet","id","invited","mean","questionText","respondents","scale","scheduledFor"],"additionalProperties":false}]},"previous":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"distribution":{"anyOf":[{"type":"null"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"invited":{"type":"number"},"mean":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"respondents":{"type":"number"},"scale":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","audienceLabel","closedAt","distribution","driver","driverLabel","enps","favourablePct","floor","floorMet","id","invited","mean","questionText","respondents","scale","scheduledFor"],"additionalProperties":false}]},"trend":{"type":"array","items":{"type":"object","properties":{"answered":{"type":"number"},"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"distribution":{"anyOf":[{"type":"null"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"invited":{"type":"number"},"mean":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"respondents":{"type":"number"},"scale":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","audienceLabel","closedAt","distribution","driver","driverLabel","enps","favourablePct","floor","floorMet","id","invited","mean","questionText","respondents","scale","scheduledFor"],"additionalProperties":false}}},"required":["latest","previous","trend"],"additionalProperties":false},"everClosed":{"type":"boolean"},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"groups":{"type":"object","properties":{"dimensions":{"type":"object","properties":{"department":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"role":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"team":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"tenure":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}}},"required":["department","role","team","tenure"],"additionalProperties":false},"drivers":{"type":"array","items":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]}}},"required":["dimensions","drivers"],"additionalProperties":false},"history":{"type":"array","items":{"type":"object","properties":{"answered":{"type":"number"},"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"distribution":{"anyOf":[{"type":"null"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"invited":{"type":"number"},"mean":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"respondents":{"type":"number"},"scale":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","audienceLabel","closedAt","distribution","driver","driverLabel","enps","favourablePct","floor","floorMet","id","invited","mean","questionText","respondents","scale","scheduledFor"],"additionalProperties":false}},"invited":{"type":"number"},"latest":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"distribution":{"anyOf":[{"type":"null"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"invited":{"type":"number"},"mean":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"respondents":{"type":"number"},"scale":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","audienceLabel","closedAt","distribution","driver","driverLabel","enps","favourablePct","floor","floorMet","id","invited","mean","questionText","respondents","scale","scheduledFor"],"additionalProperties":false}]},"open":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"closesAt":{"type":"string","format":"date-time"},"driverLabel":{"type":"string"},"id":{"type":"string"},"invited":{"type":"number"},"questionText":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"}},"required":["answered","closesAt","driverLabel","id","invited","questionText","scheduledFor"],"additionalProperties":false}]},"participationPct":{"anyOf":[{"type":"null"},{"type":"number"}]},"previousParticipationPct":{"anyOf":[{"type":"null"},{"type":"number"}]},"published":{"type":"number"},"respondents":{"type":"number"},"sends":{"type":"number"},"weekly":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"week":{"type":"string"}},"required":["value","week"],"additionalProperties":false}},"weeks":{"type":"array","items":{"type":"string"}},"windowEnd":{"type":"string","format":"date-time"},"windowStart":{"type":"string","format":"date-time"},"withheld":{"type":"number"}},"required":["answered","days","drivers","enps","everClosed","favourablePct","groups","history","invited","latest","open","participationPct","previousParticipationPct","published","respondents","sends","weekly","weeks","windowEnd","windowStart","withheld"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.insights"}},"/manage/pulse/latestRead":{"post":{"operationId":"pulse.latestRead","summary":"Read what stands out in a closed Pulse question’s result","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sendId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"change":{"anyOf":[{"type":"null"},{"type":"number"}]},"closedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"driverLabel":{"type":"string"},"enps":{"type":"boolean"},"findings":{"type":"array","items":{"type":"object","properties":{"ask":{"type":"string"},"kind":{"anyOf":[{"const":"group_gap"},{"const":"participation"},{"const":"result"},{"const":"withheld"}]},"text":{"type":"string"},"tone":{"anyOf":[{"const":"down"},{"const":"steady"},{"const":"up"},{"const":"watch"}]}},"required":["ask","kind","text","tone"],"additionalProperties":false}},"floorMet":{"type":"boolean"},"invited":{"type":"number"},"participationPct":{"anyOf":[{"type":"null"},{"type":"number"}]},"questionText":{"type":"string"},"sendId":{"type":"string"},"value":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["answered","change","closedAt","driverLabel","enps","findings","floorMet","invited","participationPct","questionText","sendId","value"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.latestRead"}},"/manage/pulse/mine":{"post":{"operationId":"pulse.mine","summary":"Read your own Pulse streak, how many took part, and what changed because of it","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"answered":{"type":"number"},"open":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"floor":{"type":"number"}},"required":["answered","floor"],"additionalProperties":false}]},"participation":{"type":"array","items":{"type":"object","properties":{"closedAt":{"type":"string","format":"date-time"},"pct":{"type":"number"},"sendId":{"type":"string"}},"required":["closedAt","pct","sendId"],"additionalProperties":false}},"published":{"type":"array","items":{"type":"object","properties":{"after":{"anyOf":[{"type":"null"},{"type":"number"}]},"before":{"anyOf":[{"type":"null"},{"type":"number"}]},"change":{"anyOf":[{"type":"null"},{"type":"number"}]},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"id":{"type":"string"},"ownerName":{"anyOf":[{"type":"null"},{"type":"string"}]},"postedAt":{"type":"string","format":"date-time"},"questionText":{"type":"string"},"text":{"anyOf":[{"type":"null"},{"type":"string"}]},"title":{"type":"string"},"unit":{"anyOf":[{"const":"eNPS"},{"const":"favourable"}]}},"required":["after","before","change","driver","driverLabel","id","ownerName","postedAt","questionText","text","title","unit"],"additionalProperties":false}},"rounds":{"type":"array","items":{"type":"object","properties":{"driverLabel":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"sendId":{"type":"string"},"status":{"anyOf":[{"const":"answered"},{"const":"missed"},{"const":"open"},{"const":"skipped"}]}},"required":["driverLabel","scheduledFor","sendId","status"],"additionalProperties":false}},"streak":{"type":"number"}},"required":["answered","open","participation","published","rounds","streak"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.mine"}},"/manage/pulse/program":{"post":{"operationId":"pulse.program","summary":"Read the Pulse settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"activatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"audience":{"type":"number"},"cadence":{"type":"string"},"enps":{"type":"object","properties":{"lastSentAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["lastSentAt"],"additionalProperties":false},"expectedCost":{"type":"object","properties":{"audience":{"type":"number"},"cost":{"type":"number"},"free":{"type":"boolean"},"text":{"type":"string"}},"required":["audience","cost","free","text"],"additionalProperties":false},"nextSendAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"openSend":{"anyOf":[{"type":"null"},{"type":"object","properties":{"closesAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"questionText":{"type":"string"}},"required":["closesAt","id","questionText"],"additionalProperties":false}]},"questions":{"type":"object","properties":{"active":{"type":"number"},"retired":{"type":"number"}},"required":["active","retired"],"additionalProperties":false},"revision":{"type":"number"},"settings":{"type":"object","properties":{"aiAnalysis":{"type":"boolean"},"enpsEnabled":{"type":"boolean"},"enpsEveryMonths":{"anyOf":[{"const":1},{"const":3},{"const":6}]},"openHours":{"type":"number"},"reportingFloor":{"type":"number"},"sendDays":{"type":"array","items":{"type":"number"}},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"timezone":{"type":"string"}},"required":["aiAnalysis","enpsEnabled","enpsEveryMonths","openHours","reportingFloor","sendDays","sendHour","sendMinute","timezone"],"additionalProperties":false},"slackReachable":{"type":"number"},"status":{"anyOf":[{"const":"active"},{"const":"draft"},{"const":"paused"}]}},"required":["activatedAt","audience","cadence","enps","expectedCost","nextSendAt","openSend","questions","revision","settings","slackReachable","status"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.program"}},"/manage/pulse/proposals":{"post":{"operationId":"pulse.proposals","summary":"List the Pulse questions Mello suggested that wait for approval","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"aiAnalysis":{"type":"boolean"},"lastRunAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"proposals":{"type":"array","items":{"type":"object","properties":{"checkReasons":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"id":{"type":"string"},"origin":{"anyOf":[{"const":"mello"},{"const":"requested"},{"const":"weekly"}]},"reason":{"type":"string"},"revision":{"type":"number"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"rating_5"},{"const":"yes_no"}]},"text":{"type":"string"},"topic":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["checkReasons","createdAt","driver","id","origin","reason","revision","scale","text","topic"],"additionalProperties":false}}},"required":["aiAnalysis","lastRunAt","proposals"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.proposals"}},"/manage/pulse/proposeQuestions":{"post":{"operationId":"pulse.proposeQuestions","summary":"Save drafted Pulse questions as suggestions for HR to approve (never asked until approved)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"questions":{"type":"array","items":{"type":"object","properties":{"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"reason":{"type":"string"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"rating_5"},{"const":"yes_no"}]},"text":{"type":"string"}},"required":["driver","scale","text"],"additionalProperties":false}},"topic":{"type":"string"},"confirm":{"const":"pulse.proposeQuestions"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["questions","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"created":{"type":"number"},"duplicates":{"type":"number"},"flagged":{"type":"number"}},"required":["created","duplicates","flagged"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.proposeQuestions"}},"/manage/pulse/questionDetail":{"post":{"operationId":"pulse.questionDetail","summary":"Read one closed Pulse question: its answer spread, every time it was asked, and results by group (groups of seven or more)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sendId":{"type":"string"}},"required":["sendId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"audienceLabel":{"anyOf":[{"type":"null"},{"type":"string"}]},"closesAt":{"type":"string","format":"date-time"},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"driverLabel":{"type":"string"},"groups":{"type":"object","properties":{"department":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"role":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"team":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}},"tenure":{"type":"array","items":{"type":"object","properties":{"drivers":{"type":"object","properties":{"ai_adoption":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"belonging":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"clarity":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"engagement":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"growth":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"manager":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"recognition":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"safety":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"tools":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false},"workload":{"type":"object","properties":{"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["favourablePct","seen"],"additionalProperties":false}},"additionalProperties":false},"enps":{"type":"object","properties":{"score":{"anyOf":[{"type":"null"},{"type":"number"}]},"seen":{"type":"boolean"}},"required":["score","seen"],"additionalProperties":false},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"label":{"type":"string"},"respondents":{"type":"number"},"seen":{"type":"boolean"},"segment":{"type":"string"}},"required":["drivers","enps","favourablePct","label","respondents","seen","segment"],"additionalProperties":false}}},"required":["department","role","team","tenure"],"additionalProperties":false},"id":{"type":"string"},"questionText":{"type":"string"},"questionVersion":{"type":"number"},"report":{"anyOf":[{"type":"null"},{"type":"object","properties":{"answered":{"type":"number"},"enps":{"anyOf":[{"type":"null"},{"type":"object","properties":{"detractors":{"type":"number"},"passives":{"type":"number"},"promoters":{"type":"number"},"score":{"type":"number"}},"required":["detractors","passives","promoters","score"],"additionalProperties":false}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"invited":{"type":"number"},"respondents":{"type":"number"},"spread":{"anyOf":[{"type":"null"},{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"label":{"type":"string"},"value":{"type":"number"}},"required":["count","label","value"],"additionalProperties":false}}]}},"required":["answered","enps","favourablePct","floor","floorMet","invited","respondents","spread"],"additionalProperties":false}]},"scale":{"anyOf":[{"const":"agree_5"},{"const":"nps_11"},{"const":"rating_5"},{"const":"yes_no"}]},"scheduledFor":{"type":"string","format":"date-time"},"status":{"anyOf":[{"const":"closed"},{"const":"open"}]},"trend":{"type":"array","items":{"type":"object","properties":{"enps":{"anyOf":[{"type":"null"},{"type":"number"}]},"favourablePct":{"anyOf":[{"type":"null"},{"type":"number"}]},"floor":{"type":"number"},"floorMet":{"type":"boolean"},"id":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"version":{"type":"number"}},"required":["enps","favourablePct","floor","floorMet","id","scheduledFor","version"],"additionalProperties":false}}},"required":["audienceLabel","closesAt","driver","driverLabel","groups","id","questionText","questionVersion","report","scale","scheduledFor","status","trend"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.questionDetail"}},"/manage/pulse/questions":{"post":{"operationId":"pulse.questions","summary":"List the Pulse question library","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"type":"object","properties":{"departmentIds":{"type":"array","items":{"type":"string"}},"role":{"anyOf":[{"const":"everyone"},{"const":"ics"},{"const":"managers"}]},"teamIds":{"type":"array","items":{"type":"string"}}},"required":["departmentIds","role","teamIds"],"additionalProperties":false}]},"audienceLabel":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"driver":{"anyOf":[{"const":"ai_adoption"},{"const":"belonging"},{"const":"clarity"},{"const":"engagement"},{"const":"growth"},{"const":"manager"},{"const":"recognition"},{"const":"safety"},{"const":"tools"},{"const":"workload"}]},"id":{"type":"string"},"lastAskedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"libraryKey":{"anyOf":[{"type":"null"},{"type":"string"}]},"position":{"type":"number"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"nps_11"},{"const":"rating_5"},{"const":"yes_no"}]},"source":{"anyOf":[{"const":"ai_proposal"},{"const":"hr"},{"const":"library"}]},"status":{"anyOf":[{"const":"active"},{"const":"retired"}]},"text":{"type":"string"},"version":{"type":"number"}},"required":["audience","audienceLabel","createdAt","driver","id","lastAskedAt","libraryKey","position","scale","source","status","text","version"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.questions"}},"/manage/pulse/requestProposals":{"post":{"operationId":"pulse.requestProposals","summary":"Ask Mello to suggest Pulse questions from recent results, optionally about a topic","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number"},"topic":{"type":"string"},"confirm":{"const":"pulse.requestProposals"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"created":{"type":"number"},"duplicates":{"type":"number"},"flagged":{"type":"number"}},"required":["created","duplicates","flagged"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.requestProposals"}},"/manage/pulse/saveProgram":{"post":{"operationId":"pulse.saveProgram","summary":"Save Pulse settings; enabling Pulse schedules questions to everyone","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"aiAnalysis":{"type":"boolean"},"enpsEnabled":{"anyOf":[{"const":false},{"const":true}]},"enpsEveryMonths":{"anyOf":[{"const":1},{"const":3},{"const":6}]},"expectedRevision":{"type":"number"},"openHours":{"type":"number"},"reportingFloor":{"type":"number"},"sendDays":{"type":"array","items":{"type":"number"}},"sendHour":{"type":"number"},"sendMinute":{"type":"number"},"status":{"anyOf":[{"const":"active"},{"const":"draft"},{"const":"paused"}]},"timezone":{"type":"string"},"confirm":{"const":"pulse.saveProgram"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["aiAnalysis","expectedRevision","openHours","reportingFloor","sendDays","sendHour","sendMinute","status","timezone","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"nextSendAt":{"not":{}},"revision":{"type":"number"},"seeded":{"type":"number"}},"required":["changed","revision","seeded"],"additionalProperties":false},{"type":"object","properties":{"changed":{"type":"boolean"},"nextSendAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"revision":{"type":"number"},"seeded":{"type":"number"}},"required":["changed","nextSendAt","revision","seeded"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.saveProgram"}},"/manage/pulse/setQuestionAudience":{"post":{"operationId":"pulse.setQuestionAudience","summary":"Aim a Pulse question at departments, teams, managers or ICs","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"type":"object","properties":{"departmentIds":{"type":"array","items":{"type":"string"}},"role":{"anyOf":[{"const":"everyone"},{"const":"ics"},{"const":"managers"}]},"teamIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}]},"questionId":{"type":"string"},"confirm":{"const":"pulse.setQuestionAudience"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["audience","questionId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"audience":{"anyOf":[{"type":"null"},{"type":"object","properties":{"departmentIds":{"type":"array","items":{"type":"string"}},"role":{"anyOf":[{"const":"everyone"},{"const":"ics"},{"const":"managers"}]},"teamIds":{"type":"array","items":{"type":"string"}}},"required":["departmentIds","role","teamIds"],"additionalProperties":false}]},"label":{"type":"string"}},"required":["audience","label"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.setQuestionAudience"}},"/manage/pulse/setQuestionStatus":{"post":{"operationId":"pulse.setQuestionStatus","summary":"Retire or restore a Pulse question","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"questionId":{"type":"string"},"status":{"anyOf":[{"const":"active"},{"const":"retired"}]},"confirm":{"const":"pulse.setQuestionStatus"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["questionId","status","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"anyOf":[{"const":"active"},{"const":"retired"}]}},"required":["id","status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.setQuestionStatus"}},"/manage/pulse/skip":{"post":{"operationId":"pulse.skip","summary":"Skip today’s Pulse question","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sendId":{"type":"string"},"confirm":{"const":"pulse.skip"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["sendId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"outcome":{"anyOf":[{"const":"closed"},{"const":"not_invited"},{"const":"skipped"}]}},"required":["outcome"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.skip"}},"/manage/pulse/today":{"post":{"operationId":"pulse.today","summary":"Read today’s Pulse question","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"floor":{"type":"number"},"lastClosed":{"anyOf":[{"type":"null"},{"type":"object","properties":{"closedAt":{"type":"string","format":"date-time"},"participationPct":{"type":"number"},"questionText":{"type":"string"}},"required":["closedAt","participationPct","questionText"],"additionalProperties":false}]},"nextSendAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"send":{"anyOf":[{"type":"null"},{"type":"object","properties":{"closesAt":{"type":"string","format":"date-time"},"driver":{"type":"string"},"id":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"number"}},"required":["label","value"],"additionalProperties":false}},"questionText":{"type":"string"},"scale":{"anyOf":[{"const":"agree_5"},{"const":"nps_11"},{"const":"rating_5"},{"const":"yes_no"}]},"scheduledFor":{"type":"string","format":"date-time"}},"required":["closesAt","driver","id","options","questionText","scale","scheduledFor"],"additionalProperties":false}]},"status":{"anyOf":[{"const":"answered"},{"const":"closed"},{"const":"not_invited"},{"const":"pending"},{"const":"skipped"}]},"timezone":{"type":"string"}},"required":["floor","lastClosed","nextSendAt","send","status","timezone"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"pulse.today"}},"/manage/pulse/updateAction":{"post":{"operationId":"pulse.updateAction","summary":"Change a Pulse action’s wording, owner, due date or status","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"actionId":{"type":"string"},"detail":{"anyOf":[{"type":"null"},{"type":"string"}]},"dueOn":{"type":"string"},"expectedRevision":{"type":"number"},"ownerPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"recheck":{"anyOf":[{"const":false},{"const":true}]},"status":{"anyOf":[{"const":"done"},{"const":"dropped"},{"const":"in_progress"},{"const":"planned"}]},"title":{"type":"string"},"confirm":{"const":"pulse.updateAction"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["actionId","dueOn","expectedRevision","status","title","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"revision":{"type":"number"},"status":{"anyOf":[{"const":"done"},{"const":"dropped"},{"const":"in_progress"},{"const":"planned"}]},"statusChanged":{"type":"boolean"}},"required":["revision","status","statusChanged"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"pulse.updateAction"}},"/manage/reminders/mine":{"post":{"operationId":"reminders.mine","summary":"Read your own Praise and Pulse reminder choices","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"kinds":{"type":"array","items":{"type":"object","properties":{"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"default"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"effective":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"kind":{"anyOf":[{"const":"manager_check_in"},{"const":"new_hire_check_in"},{"const":"praise"},{"const":"pulse"}]},"options":{"type":"array","items":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"quarterly"},{"const":"weekly"}]}},"team":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]}},"required":["choice","effective","kind","options","team"],"additionalProperties":false}},"linked":{"type":"boolean"}},"required":["kinds","linked"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reminders.mine"}},"/manage/reminders/saveMine":{"post":{"operationId":"reminders.saveMine","summary":"Change or turn off your own Praise or Pulse reminders","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"choice":{"type":"string"},"kind":{"anyOf":[{"const":"manager_check_in"},{"const":"new_hire_check_in"},{"const":"praise"},{"const":"pulse"}]},"confirm":{"const":"reminders.saveMine"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["choice","kind","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"kinds":{"type":"array","items":{"type":"object","properties":{"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"default"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"effective":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"kind":{"anyOf":[{"const":"manager_check_in"},{"const":"new_hire_check_in"},{"const":"praise"},{"const":"pulse"}]},"options":{"type":"array","items":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"quarterly"},{"const":"weekly"}]}},"team":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]}},"required":["choice","effective","kind","options","team"],"additionalProperties":false}},"linked":{"type":"boolean"}},"required":["changed","kinds","linked"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"reminders.saveMine"}},"/manage/reminders/saveSetting":{"post":{"operationId":"reminders.saveSetting","summary":"Turn a Praise or Pulse reminder on or off, or change its timing","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"choice":{"type":"string"},"kind":{"anyOf":[{"const":"manager_check_in"},{"const":"new_hire_check_in"},{"const":"praise"},{"const":"pulse"}]},"confirm":{"const":"reminders.saveSetting"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["choice","kind","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"kind":{"anyOf":[{"const":"manager_check_in"},{"const":"new_hire_check_in"},{"const":"praise"},{"const":"pulse"}]}},"required":["changed","choice","kind"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"reminders.saveSetting"}},"/manage/reminders/settings":{"post":{"operationId":"reminders.settings","summary":"Read whether Praise and Pulse reminders are on, and their timing","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"manager_check_in":{"type":"object","properties":{"available":{"type":"boolean"},"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"optedOut":{"type":"number"},"options":{"type":"array","items":{"type":"string"}}},"required":["available","choice","optedOut","options"],"additionalProperties":false},"new_hire_check_in":{"type":"object","properties":{"available":{"type":"boolean"},"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"optedOut":{"type":"number"},"options":{"type":"array","items":{"type":"string"}}},"required":["available","choice","optedOut","options"],"additionalProperties":false},"praise":{"type":"object","properties":{"available":{"type":"boolean"},"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"optedOut":{"type":"number"},"options":{"type":"array","items":{"type":"string"}}},"required":["available","choice","optedOut","options"],"additionalProperties":false},"pulse":{"type":"object","properties":{"available":{"type":"boolean"},"choice":{"anyOf":[{"const":"before_close"},{"const":"biweekly"},{"const":"every_2_weeks"},{"const":"first_90_days"},{"const":"first_year"},{"const":"monthly"},{"const":"next_day"},{"const":"off"},{"const":"quarterly"},{"const":"weekly"}]},"optedOut":{"type":"number"},"options":{"type":"array","items":{"type":"string"}}},"required":["available","choice","optedOut","options"],"additionalProperties":false}},"required":["manager_check_in","new_hire_check_in","praise","pulse"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reminders.settings"}},"/manage/reports/answerFeedback":{"post":{"operationId":"reports.answerFeedback","summary":"Read feedback on Mello's answers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":7},{"const":30},{"const":90}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"days":{"type":"number"},"down":{"type":"number"},"recent":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string"},"note":{"anyOf":[{"type":"null"},{"type":"string"}]},"rating":{"anyOf":[{"const":"down"},{"const":"up"}]},"sources":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"string"},"title":{"type":"string"}},"required":["sourceId","title"],"additionalProperties":false}}},"required":["at","note","rating","sources"],"additionalProperties":false}},"up":{"type":"number"}},"required":["days","down","recent","up"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.answerFeedback"}},"/manage/reports/connections":{"post":{"operationId":"reports.connections","summary":"Read Connections insights","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]},"programId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"end":{"type":"string","format":"date-time"},"introductions":{"type":"object","properties":{"current":{"type":"object","properties":{"groups":{"type":"number"},"people":{"type":"number"}},"required":["groups","people"],"additionalProperties":false},"previous":{"type":"object","properties":{"groups":{"type":"number"},"people":{"type":"number"}},"required":["groups","people"],"additionalProperties":false}},"required":["current","previous"],"additionalProperties":false},"pairs":{"type":"object","properties":{"acrossTeams":{"type":"number"},"firstTime":{"type":"number"},"total":{"type":"number"},"withTeams":{"type":"number"}},"required":["acrossTeams","firstTime","total","withTeams"],"additionalProperties":false},"participation":{"type":"object","properties":{"inChannel":{"type":"number"},"onBreak":{"type":"number"},"takingPart":{"type":"number"}},"required":["inChannel","onBreak","takingPart"],"additionalProperties":false},"start":{"type":"string","format":"date-time"},"weekly":{"type":"array","items":{"type":"object","properties":{"groups":{"type":"number"},"people":{"type":"number"},"week":{"type":"string"}},"required":["groups","people","week"],"additionalProperties":false}},"window":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"required":["end","introductions","pairs","participation","start","weekly","window"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.connections"}},"/manage/reports/knowledge":{"post":{"operationId":"reports.knowledge","summary":"Read Knowledge activity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":7},{"const":30},{"const":90}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"attention":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"const":"no_match"},{"const":"no_permitted_sources"},{"const":"pending_verification"},{"const":"review_overdue"},{"const":"revoked_or_conflicting"},{"const":"stale"},{"const":"withdrawn"},{"const":"withheld"}]},"measured":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["kind","measured"],"additionalProperties":false}},"collectionStartedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"coverage":{"anyOf":[{"const":"complete"},{"const":"partial"},{"const":"unavailable"}]},"hr":{"type":"object","properties":{"confirmationDenominator":{"type":"number"},"current":{"type":"object","properties":{"casesOpened":{"type":"number"},"casesReopened":{"type":"number"},"casesWithAReply":{"type":"number"},"closedByHr":{"type":"number"},"confirmedByRequester":{"type":"number"},"resolvedActorUnknown":{"type":"number"}},"required":["casesOpened","casesReopened","casesWithAReply","closedByHr","confirmedByRequester","resolvedActorUnknown"],"additionalProperties":false},"previous":{"type":"object","properties":{"casesOpened":{"type":"number"},"casesReopened":{"type":"number"},"casesWithAReply":{"type":"number"},"closedByHr":{"type":"number"},"confirmedByRequester":{"type":"number"},"resolvedActorUnknown":{"type":"number"}},"required":["casesOpened","casesReopened","casesWithAReply","closedByHr","confirmedByRequester","resolvedActorUnknown"],"additionalProperties":false}},"required":["confirmationDenominator","current","previous"],"additionalProperties":false},"knowledge":{"type":"object","properties":{"byDay":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"kind":{"anyOf":[{"const":"cited"},{"const":"guidance_proposed"},{"const":"guidance_reused"},{"const":"guidance_verified"},{"const":"no_evidence"},{"const":"retrieved"}]},"total":{"type":"number"}},"required":["day","kind","total"],"additionalProperties":false}},"current":{"type":"object","properties":{"answeredWithEvidence":{"type":"number"},"citedSuppressed":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"denominator":{"type":"number"},"noEvidence":{"type":"number"},"noEvidenceSuppressed":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"retrieved":{"type":"number"}},"required":["answeredWithEvidence","citedSuppressed","denominator","noEvidence","noEvidenceSuppressed","retrieved"],"additionalProperties":false},"funnel":{"type":"object","properties":{"proposed":{"type":"number"},"reused":{"type":"number"},"verified":{"type":"number"}},"required":["proposed","reused","verified"],"additionalProperties":false},"previous":{"type":"object","properties":{"answeredWithEvidence":{"type":"number"},"denominator":{"type":"number"},"noEvidence":{"type":"number"},"retrieved":{"type":"number"}},"required":["answeredWithEvidence","denominator","noEvidence","retrieved"],"additionalProperties":false},"sources":{"type":"array","items":{"type":"object","properties":{"cited":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"citedBefore":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"pendingProposalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"publishedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"retrieved":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"retrievedBefore":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"revision":{"anyOf":[{"type":"null"},{"type":"number"}]},"sourceId":{"type":"string"},"state":{"anyOf":[{"const":"archived"},{"const":"published"},{"const":"unreadable"},{"const":"withdrawn"}]},"title":{"anyOf":[{"type":"null"},{"type":"string"}]},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"withdrawalReason":{"anyOf":[{"type":"null"},{"const":"access_lost"},{"const":"hr"}]}},"required":["cited","citedBefore","pendingProposalId","publishedAt","retrieved","retrievedBefore","revision","sourceId","state","title","updatedAt","withdrawalReason"],"additionalProperties":false}}},"required":["byDay","current","funnel","previous","sources"],"additionalProperties":false},"openNow":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"units":{"type":"object","properties":{"answeredWithEvidence":{"type":"string"},"casesOpened":{"type":"string"},"denominator":{"type":"string"},"retrieved":{"type":"string"}},"required":["answeredWithEvidence","casesOpened","denominator","retrieved"],"additionalProperties":false},"window":{"anyOf":[{"const":7},{"const":30},{"const":90}]},"windowEnd":{"type":"string","format":"date-time"},"windowStart":{"type":"string","format":"date-time"}},"required":["attention","collectionStartedAt","coverage","hr","knowledge","openNow","units","window","windowEnd","windowStart"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.knowledge"}},"/manage/reports/knowledgeSource":{"post":{"operationId":"reports.knowledgeSource","summary":"Read activity for one Knowledge source","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":7},{"const":30},{"const":90}]},"sourceId":{"type":"string"}},"required":["sourceId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"cited":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"citedBefore":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"coverage":{"anyOf":[{"const":"complete"},{"const":"partial"},{"const":"unavailable"}]},"pendingProposalId":{"anyOf":[{"type":"null"},{"type":"string"}]},"retrieved":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"retrievedBefore":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"window":{"anyOf":[{"const":7},{"const":30},{"const":90}]},"windowEnd":{"type":"string","format":"date-time"},"windowStart":{"type":"string","format":"date-time"}},"required":["cited","citedBefore","coverage","pendingProposalId","retrieved","retrievedBefore","window","windowEnd","windowStart"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.knowledgeSource"}},"/manage/reports/melloTrial":{"post":{"operationId":"reports.melloTrial","summary":"What Mello handled during the trial, from day 25 of a trial until it ends","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"null"},{"type":"object","properties":{"current":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false},"endsAt":{"type":"string","format":"date-time"},"minutesPerQuestion":{"anyOf":[{"type":"null"},{"type":"number"}]},"minutesSaved":{"anyOf":[{"type":"null"},{"type":"number"}]},"startedAt":{"type":"string","format":"date-time"}},"required":["current","endsAt","minutesPerQuestion","minutesSaved","startedAt"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.melloTrial"}},"/manage/reports/melloValue":{"post":{"operationId":"reports.melloValue","summary":"What Mello handled this week, this month and all time, with time saved once the team has set its minutes per question","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"allTime":{"type":"object","properties":{"coverage":{"type":"string"},"current":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false},"minutesSaved":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["coverage","current","minutesSaved"],"additionalProperties":false},"collectionStartedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"minutesPerQuestion":{"anyOf":[{"type":"null"},{"type":"number"}]},"month":{"type":"object","properties":{"coverage":{"anyOf":[{"const":"complete"},{"const":"partial"},{"const":"unavailable"}]},"current":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false},"minutesSaved":{"anyOf":[{"type":"null"},{"type":"number"}]},"previous":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false}},"required":["coverage","current","minutesSaved","previous"],"additionalProperties":false},"units":{"type":"object","properties":{"answered":{"type":"string"},"handledWithoutHr":{"type":"string"},"minutesSaved":{"type":"string"},"questions":{"type":"string"}},"required":["answered","handledWithoutHr","minutesSaved","questions"],"additionalProperties":false},"week":{"type":"object","properties":{"coverage":{"anyOf":[{"const":"complete"},{"const":"partial"},{"const":"unavailable"}]},"current":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false},"minutesSaved":{"anyOf":[{"type":"null"},{"type":"number"}]},"previous":{"type":"object","properties":{"actions":{"type":"object","properties":{"answers":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"appActionsDone":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"buddyAccepted":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"hrRequestsSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"onboardingMessagesSent":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"praiseTiedToValues":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["answers","appActionsDone","buddyAccepted","hrRequestsSent","onboardingMessagesSent","praiseTiedToValues"],"additionalProperties":false},"answered":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"end":{"type":"string","format":"date-time"},"handledShare":{"anyOf":[{"type":"null"},{"type":"number"}]},"handledWithoutHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"questions":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"start":{"type":"string","format":"date-time"},"total":{"type":"number"},"unknown":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]},"wentToHr":{"anyOf":[{"type":"object","properties":{"status":{"const":"available"},"value":{"type":"number"}},"required":["status","value"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"suppressed"}},"required":["status"],"additionalProperties":false}]}},"required":["actions","answered","end","handledShare","handledWithoutHr","questions","start","total","unknown","wentToHr"],"additionalProperties":false}},"required":["coverage","current","minutesSaved","previous"],"additionalProperties":false}},"required":["allTime","collectionStartedAt","minutesPerQuestion","month","units","week"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.melloValue"}},"/manage/reports/needsYou":{"post":{"operationId":"reports.needsYou","summary":"Read HR request and Knowledge draft insights","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"answeredByArticle":{"type":"number"},"due":{"type":"number"},"firstReplySeconds":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"anyOf":[{"type":"null"},{"type":"string"}]},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"needsArticle":{"type":"number"},"received":{"type":"number"},"replied":{"type":"number"},"withinTarget":{"type":"number"}},"required":["answeredByArticle","due","firstReplySeconds","id","name","needsArticle","received","replied","withinTarget"],"additionalProperties":false}},"drafts":{"type":"object","properties":{"approved":{"type":"number"},"pending":{"type":"number"},"rejected":{"type":"number"}},"required":["approved","pending","rejected"],"additionalProperties":false},"end":{"type":"string","format":"date-time"},"months":{"type":"array","items":{"type":"object","properties":{"answeredByArticle":{"type":"number"},"due":{"type":"number"},"firstReplySeconds":{"anyOf":[{"type":"null"},{"type":"number"}]},"month":{"type":"string"},"needsArticle":{"type":"number"},"received":{"type":"number"},"replied":{"type":"number"},"withinTarget":{"type":"number"}},"required":["answeredByArticle","due","firstReplySeconds","month","needsArticle","received","replied","withinTarget"],"additionalProperties":false}},"requests":{"type":"object","properties":{"firstReplySeconds":{"anyOf":[{"type":"null"},{"type":"number"}]},"previous":{"type":"number"},"received":{"type":"number"},"replied":{"type":"number"},"resolved":{"type":"number"},"resolveSeconds":{"anyOf":[{"type":"null"},{"type":"number"}]},"stale":{"type":"number"},"waiting":{"type":"number"}},"required":["firstReplySeconds","previous","received","replied","resolved","resolveSeconds","stale","waiting"],"additionalProperties":false},"start":{"type":"string","format":"date-time"},"target":{"type":"object","properties":{"answeredByArticle":{"type":"number"},"days":{"type":"number"},"due":{"type":"number"},"firstReplySeconds":{"anyOf":[{"type":"null"},{"type":"number"}]},"needsArticle":{"type":"number"},"received":{"type":"number"},"replied":{"type":"number"},"withinTarget":{"type":"number"}},"required":["answeredByArticle","days","due","firstReplySeconds","needsArticle","received","replied","withinTarget"],"additionalProperties":false},"weekly":{"type":"array","items":{"type":"object","properties":{"requests":{"type":"number"},"week":{"type":"string"}},"required":["requests","week"],"additionalProperties":false}},"window":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"required":["categories","drafts","end","months","requests","start","target","weekly","window"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.needsYou"}},"/manage/reports/onboarding":{"post":{"operationId":"reports.onboarding","summary":"Read Onboarding insights","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]},"programId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"buddies":{"type":"object","properties":{"accepted":{"type":"number"},"declined":{"type":"number"},"waiting":{"type":"number"}},"required":["accepted","declined","waiting"],"additionalProperties":false},"checkIns":{"type":"object","properties":{"answered":{"type":"number"},"due":{"type":"number"},"needHelp":{"type":"number"}},"required":["answered","due","needHelp"],"additionalProperties":false},"end":{"type":"string","format":"date-time"},"hires":{"type":"object","properties":{"enrolled":{"type":"number"},"inProgress":{"type":"number"}},"required":["enrolled","inProgress"],"additionalProperties":false},"messages":{"type":"object","properties":{"byKind":{"type":"array","items":{"type":"object","properties":{"failed":{"type":"number"},"kind":{"anyOf":[{"const":"buddy_invitation"},{"const":"check_in"},{"const":"introduction"}]},"onTime":{"type":"number"},"sent":{"type":"number"}},"required":["failed","kind","onTime","sent"],"additionalProperties":false}},"failed":{"type":"number"},"onTime":{"type":"number"},"sent":{"type":"number"}},"required":["byKind","failed","onTime","sent"],"additionalProperties":false},"start":{"type":"string","format":"date-time"},"weekly":{"type":"array","items":{"type":"object","properties":{"hires":{"type":"number"},"week":{"type":"string"}},"required":["hires","week"],"additionalProperties":false}},"window":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"required":["buddies","checkIns","end","hires","messages","start","weekly","window"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.onboarding"}},"/manage/reports/overview":{"post":{"operationId":"reports.overview","summary":"Read the workspace overview figures","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"capabilities":{"type":"object","properties":{"manageTeam":{"type":"boolean"},"respondToHr":{"type":"boolean"},"reviewKnowledge":{"type":"boolean"}},"required":["manageTeam","respondToHr","reviewKnowledge"],"additionalProperties":false},"internal":{"type":"boolean"},"local":{"type":"boolean"},"participants":{"type":"number"},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"programs":{"type":"array","items":{"type":"object","properties":{"audience":{"type":"object","properties":{"eligible":{"type":"number"},"exclusions":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"reason":{"anyOf":[{"const":"absent"},{"const":"access_unavailable"},{"const":"bot"},{"const":"inactive"},{"const":"paused"},{"const":"slack_unavailable"}]}},"required":["count","reason"],"additionalProperties":false}},"paused":{"type":"number"},"programId":{"type":"string"},"total":{"type":"number"}},"required":["eligible","exclusions","paused","programId","total"],"additionalProperties":false},"awaitingHandover":{"type":"boolean"},"channelId":{"type":"string"},"channelName":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"includeBios":{"type":"boolean"},"includeSchedulingLink":{"type":"boolean"},"intro":{"type":"string"},"kind":{"anyOf":[{"const":"introductions"},{"const":"onboarding"}]},"match":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"anyOf":[{"const":"cross-unit"},{"const":"group-frequency-weighted"},{"const":"group-frequency-weighted-v2"},{"const":"hosted"},{"const":"new-connections"},{"const":"random"},{"const":"unit-lottery-weighted"},{"const":"unit-weighted"},{"const":"unit-weighted-multiple-hosts-per-group"},{"const":"unit-weighted-one-host-per-group"},{"const":"within-unit"}]},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"matchingReviewRequired":{"type":"boolean"},"name":{"type":"string"},"nextRunAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"onboarding":{"anyOf":[{"type":"null"},{"type":"object","properties":{"buddyInvitation":{"type":"string"},"buddyOffsetDays":{"type":"number"},"checkIn":{"type":"string"},"checkInOffsetDays":{"type":"number"},"introductionOffsetDays":{"type":"number"},"responderPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"sendTime":{"type":"string"},"timezone":{"type":"string"}},"required":["buddyInvitation","buddyOffsetDays","checkIn","checkInOffsetDays","introductionOffsetDays","responderPersonId","sendTime","timezone"],"additionalProperties":false}]},"revision":{"type":"number"},"rosterSyncedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"schedule":{"anyOf":[{"type":"object","properties":{"anchor":{"type":"string"},"frequency":{"anyOf":[{"const":"days"},{"const":"hours"},{"const":"minutes"},{"const":"monthly-date"},{"const":"monthly-last-weekday"},{"const":"monthly-weekday"},{"const":"weeks"}]},"interval":{"type":"number"},"timezone":{"type":"string"}},"required":["anchor","frequency","interval","timezone"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"type":"string"},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"source-pending"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","timezone","version"],"additionalProperties":false},{"type":"object","properties":{"anchor":{"anyOf":[{"type":"null"},{"type":"string"}]},"calendar":{"type":"object","properties":{"boundary":{"anyOf":[{"const":"end"},{"const":"start"}]},"hour":{"type":"number"},"minute":{"type":"number"},"second":{"type":"number"},"timezone":{"type":"string"},"weekday":{"type":"number"}},"required":["boundary","hour","minute","second","timezone","weekday"],"additionalProperties":false},"frequency":{"const":"legacy-monthly"},"insufficientOptInsNotice":{"type":"object","properties":{"future":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]},"pending":{"anyOf":[{"type":"null"},{"const":false},{"const":true}]}},"required":["future","pending"],"additionalProperties":false},"interval":{"const":1},"origin":{"const":"operator-future-start"},"timezone":{"type":"string"},"version":{"const":1}},"required":["anchor","calendar","frequency","insufficientOptInsNotice","interval","origin","timezone","version"],"additionalProperties":false}]},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"}]},"teamId":{"type":"string"},"upcoming":{"type":"array","items":{"type":"string","format":"date-time"}}},"required":["audience","awaitingHandover","channelId","channelName","createdAt","id","includeBios","includeSchedulingLink","intro","kind","match","matchingReviewRequired","name","nextRunAt","onboarding","revision","rosterSyncedAt","schedule","status","teamId","upcoming"],"additionalProperties":false}},"role":{"anyOf":[{"const":"admin"},{"const":"member"},{"const":"owner"}]},"runs":{"type":"array","items":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false}},"team":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":"string"},"policy":{"type":"object","properties":{"maxParticipants":{"anyOf":[{"type":"null"},{"type":"number"}]},"maxPrograms":{"anyOf":[{"type":"null"},{"type":"number"}]},"name":{"anyOf":[{"const":"community"},{"const":"grandfathered"},{"const":"per-seat"},{"const":"pro"}]},"version":{"type":"string"}},"required":["maxParticipants","maxPrograms","name","version"],"additionalProperties":false},"slackTeamId":{"anyOf":[{"type":"null"},{"type":"string"}]},"status":{"anyOf":[{"const":"active"},{"const":"archived"},{"const":"paused"},{"const":"uninstalled"}]}},"required":["id","name","organizationId","policy","slackTeamId","status"],"additionalProperties":false}]},"userId":{"type":"string"},"userName":{"type":"string"},"you":{"anyOf":[{"type":"null"},{"type":"object","properties":{"personId":{"type":"string"},"programs":{"type":"array","items":{"type":"object","properties":{"optedIn":{"type":"boolean"},"present":{"type":"boolean"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"const":"absent"},{"const":"access_unavailable"},{"const":"bot"},{"const":"inactive"},{"const":"paused"},{"const":"slack_unavailable"}]}},"required":["optedIn","present","programId","reason"],"additionalProperties":false}}},"required":["personId","programs"],"additionalProperties":false}]}},"required":["capabilities","internal","local","photoUrl","programs","role","runs","team","userId","userName","you"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.overview"}},"/manage/reports/people":{"post":{"operationId":"reports.people","summary":"Read People insights: headcount, teams and growth","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"days":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"coverage":{"type":"object","properties":{"directorySync":{"type":"number"},"noManager":{"type":"number"},"noTeam":{"type":"number"},"slack":{"type":"number"}},"required":["directorySync","noManager","noTeam","slack"],"additionalProperties":false},"departures":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"],"additionalProperties":false},"end":{"type":"string","format":"date-time"},"headcount":{"type":"object","properties":{"current":{"type":"number"},"ended":{"type":"number"},"onLeave":{"type":"number"},"withStartDate":{"type":"number"}},"required":["current","ended","onLeave","withStartDate"],"additionalProperties":false},"joins":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"],"additionalProperties":false},"roles":{"type":"object","properties":{"admin":{"type":"number"},"hrResponder":{"type":"number"},"knowledgeVerifier":{"type":"number"},"owner":{"type":"number"}},"required":["admin","hrResponder","knowledgeVerifier","owner"],"additionalProperties":false},"start":{"type":"string","format":"date-time"},"weekly":{"type":"object","properties":{"departures":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"week":{"type":"string"}},"required":["value","week"],"additionalProperties":false}},"joins":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"week":{"type":"string"}},"required":["value","week"],"additionalProperties":false}}},"required":["departures","joins"],"additionalProperties":false},"window":{"anyOf":[{"const":30},{"const":90},{"const":180}]}},"required":["coverage","departures","end","headcount","joins","roles","start","weekly","window"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"reports.people"}},"/manage/runs/details":{"post":{"operationId":"runs.details","summary":"Read one introduction round and its pairs","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string"}},"required":["runId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"deliveries":{"type":"array","items":{"type":"object","properties":{"attempts":{"type":"number"},"component":{"anyOf":[{"const":"bio"},{"const":"bio_invite"},{"const":"channel_notice"},{"const":"email"},{"const":"intro"},{"const":"open"}]},"errorCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"groupId":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"state":{"anyOf":[{"const":"attempting"},{"const":"canceled"},{"const":"failed"},{"const":"pending"},{"const":"sent"},{"const":"unknown"}]}},"required":["attempts","component","errorCode","groupId","id","state"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"canceledAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"channelId":{"anyOf":[{"type":"null"},{"type":"string"}]},"deliveredAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"ordinal":{"type":"number"},"runId":{"type":"string"},"teamId":{"type":"string"}},"required":["canceledAt","channelId","deliveredAt","id","ordinal","runId","teamId"],"additionalProperties":false}},"members":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string"},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["groupId","member","photoUrl"],"additionalProperties":false}},"run":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false},"unmatched":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}},"required":["deliveries","groups","members","run","unmatched"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"runs.details"}},"/manage/runs/dispatch":{"post":{"operationId":"runs.dispatch","summary":"Dispatch this queued introduction run","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string"},"confirm":{"const":"runs.dispatch"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["runId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"started":{"type":"boolean"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["started","workflowId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"runs.dispatch"}},"/manage/runs/history/get":{"post":{"operationId":"runs.history.get","summary":"Read one introduction round imported from the previous Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"observationId":{"type":"string"}},"required":["observationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"archiveSnapshotId":{"type":"string"},"configuration":{"const":"unknown"},"exactCancellationTime":{"const":"unknown"},"exactDeliveryTime":{"const":"unknown"},"groupMetadata":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"source":{"type":"string"},"sourceId":{"type":"string"},"sourceSha256":{"type":"string"}},"required":["fields","source","sourceId","sourceSha256"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"source":{"type":"string"},"sourceId":{"type":"string"},"sourceSha256":{"type":"string"}},"required":["fields","source","sourceId","sourceSha256"],"additionalProperties":false}},"kind":{"const":"historical-observation"},"memberships":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"personBinding":{"const":"unresolved"},"source":{"type":"string"},"sourceId":{"type":"string"},"sourceSha256":{"type":"string"}},"required":["fields","personBinding","source","sourceId","sourceSha256"],"additionalProperties":false}},"observationId":{"type":"string"},"outcome":{"const":"unknown"},"references":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"table":{"anyOf":[{"const":"event_definition"},{"const":"user"}]},"tenantId":{"type":"string"}},"required":["id","table","tenantId"],"additionalProperties":false}},"relationships":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"sourceId":{"type":"string"},"sourceTable":{"type":"string"},"status":{"anyOf":[{"const":"foreign"},{"const":"matched-observation"},{"const":"mismatched"},{"const":"missing"},{"const":"unresolved"}]}},"required":["field","sourceId","sourceTable","status"],"additionalProperties":false}},"run":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"source":{"type":"string"},"sourceId":{"type":"string"},"sourceSha256":{"type":"string"}},"required":["fields","source","sourceId","sourceSha256"],"additionalProperties":false},"sourceRunId":{"type":"string"},"sourceTenantId":{"type":"string"},"workflowReadbacks":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"source":{"type":"string"},"sourceId":{"type":"string"},"sourceSha256":{"type":"string"}},"required":["fields","source","sourceId","sourceSha256"],"additionalProperties":false}}},"required":["archiveSnapshotId","configuration","exactCancellationTime","exactDeliveryTime","groupMetadata","groups","kind","memberships","observationId","outcome","references","relationships","run","sourceRunId","sourceTenantId","workflowReadbacks"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"runs.history.get"}},"/manage/runs/history/list":{"post":{"operationId":"runs.history.list","summary":"List introduction rounds imported from the previous Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"},"rows":{"type":"array","items":{"type":"object","properties":{"groups":{"type":"number"},"kind":{"const":"historical-observation"},"memberships":{"type":"number"},"observationId":{"type":"string"},"outcome":{"const":"unknown"},"recordedCreatedAt":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}}]},"recordedState":{"anyOf":[{"type":"null"},{"type":"string"},{"type":"number"},{"const":false},{"const":true},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}}]},"sourceRunId":{"type":"string"}},"required":["groups","kind","memberships","observationId","outcome","recordedCreatedAt","recordedState","sourceRunId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["page","rows","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"runs.history.list"}},"/manage/runs/list":{"post":{"operationId":"runs.list","summary":"List a program's introduction rounds","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"},"programId":{"type":"string"},"status":{"anyOf":[{"const":"all"},{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number"},"rows":{"type":"array","items":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["page","rows","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"runs.list"}},"/manage/runs/retry":{"post":{"operationId":"runs.retry","summary":"Retry introduction delivery","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string"},"confirm":{"const":"runs.retry"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["runId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"runs.retry"}},"/manage/runs/stopKnownFailures":{"post":{"operationId":"runs.stopKnownFailures","summary":"Stop retrying known failed deliveries and advance the preserved monthly schedule","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string"},"confirm":{"const":"runs.stopKnownFailures"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["runId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"config":{"type":"object","properties":{"fineTune":{"type":"object","properties":{"commonGround":{"anyOf":[{"const":0},{"const":1},{"const":2}]},"meetRequests":{"type":"boolean"},"mentionCommonGround":{"type":"boolean"},"reach":{"anyOf":[{"const":"any"},{"const":"far"},{"const":"fof"}]}},"required":["commonGround","meetRequests","mentionCommonGround","reach"],"additionalProperties":false},"groupSize":{"type":"number"},"iterations":{"type":"number"},"keepApart":{"type":"object","properties":{"relationships":{"type":"array","items":{"anyOf":[{"const":"department"},{"const":"know-each-other"},{"const":"reporting-line"},{"const":"team"}]}},"strict":{"type":"boolean"}},"required":["relationships","strict"],"additionalProperties":false},"maxGroupSize":{"type":"number"},"strategy":{"type":"string"},"unitIds":{"type":"array","items":{"type":"string"}},"unitKind":{"anyOf":[{"const":"department"},{"const":"team"}]}},"required":["groupSize","iterations","maxGroupSize","strategy"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"eligibleCount":{"type":"number"},"historyFinalizedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"id":{"type":"string"},"occurrence":{"type":"string","format":"date-time"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string"},"revision":{"type":"number"},"seed":{"type":"string"},"selectedCount":{"type":"number"},"status":{"anyOf":[{"const":"canceled"},{"const":"completed"},{"const":"delivering"},{"const":"needs_review"},{"const":"partial"},{"const":"planned"},{"const":"queued"},{"const":"skipped"}]},"teamId":{"type":"string"},"workflowId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["completedAt","config","createdAt","eligibleCount","historyFinalizedAt","id","occurrence","programId","reason","requestKey","revision","seed","selectedCount","status","teamId","workflowId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"runs.stopKnownFailures"}},"/runs/{id}":{"get":{"operationId":"runs.get","summary":"Get the durable status of a run","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","minLength":1,"maxLength":128},"programId":{"type":"string","minLength":1,"maxLength":128},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string"}},"required":["createdAt","id","programId","reason","status"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"runs.get"}},"/runs":{"post":{"operationId":"runs.request","summary":"Queue introductions using a preview and idempotent request key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"preview":{"type":"object","properties":{"fingerprint":{"type":"string","minLength":64,"maxLength":64},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"seed":{"type":"string","minLength":1,"maxLength":128}},"required":["fingerprint","revision","seed"]},"programId":{"type":"string","minLength":1,"maxLength":128},"requestKey":{"type":"string","minLength":8,"maxLength":120}},"required":["preview","programId","requestKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"status":{"type":"string"}},"required":["id","status"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"runs.request"}},"/manage/support/assign":{"post":{"operationId":"support.assign","summary":"Assign a Shuffl support conversation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"anyOf":[{"const":"claim"},{"const":"release"}]},"expectedRevision":{"type":"number"},"threadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["action","expectedRevision","threadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"assignmentRevision":{"type":"number"},"saved":{"type":"boolean"}},"required":["assignmentRevision","saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"support.assign"}},"/manage/support/close":{"post":{"operationId":"support.close","summary":"Close a Shuffl support conversation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean"},"threadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["closed","threadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"support.close"}},"/manage/support/create":{"post":{"operationId":"support.create","summary":"Start a support conversation with Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"subject":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["body","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"assignment":{"anyOf":[{"type":"null"},{"type":"object","properties":{"assigned":{"type":"boolean"},"mine":{"type":"boolean"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"revision":{"type":"number"}},"required":["assigned","mine","name","revision"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"requesterId":{"type":"string"},"status":{"anyOf":[{"const":"closed"},{"const":"open"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["assignment","createdAt","id","requesterId","status","subject","teamId","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"support.create"}},"/manage/support/get":{"post":{"operationId":"support.get","summary":"Read one Shuffl support conversation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mine":{"anyOf":[{"const":false},{"const":true}]},"threadId":{"type":"string"}},"required":["threadId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"canReviewDelivery":{"type":"boolean"},"messages":{"type":"array","items":{"type":"object","properties":{"authorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"authorRole":{"anyOf":[{"const":"customer"},{"const":"email"},{"const":"operator"}]},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"delivery":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"messageId":{"anyOf":[{"type":"null"},{"type":"string"}]},"state":{"anyOf":[{"const":"attempting"},{"const":"canceled"},{"const":"failed"},{"const":"pending"},{"const":"sent"},{"const":"unknown"}]}},"required":["id","messageId","state"],"additionalProperties":false}]},"id":{"type":"string"},"privateNote":{"type":"boolean"},"providerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"threadId":{"type":"string"}},"required":["authorId","authorRole","body","createdAt","delivery","id","privateNote","providerId","teamId","threadId"],"additionalProperties":false}},"thread":{"type":"object","properties":{"assignment":{"anyOf":[{"type":"null"},{"type":"object","properties":{"assigned":{"type":"boolean"},"mine":{"type":"boolean"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"revision":{"type":"number"}},"required":["assigned","mine","name","revision"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"requesterId":{"type":"string"},"status":{"anyOf":[{"const":"closed"},{"const":"open"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["assignment","createdAt","id","requesterId","status","subject","teamId","updatedAt"],"additionalProperties":false}},"required":["canReviewDelivery","messages","thread"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"support.get"}},"/manage/support/list":{"post":{"operationId":"support.list","summary":"List the workspace's support conversations with Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mine":{"anyOf":[{"const":false},{"const":true}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"assignment":{"anyOf":[{"type":"null"},{"type":"object","properties":{"assigned":{"type":"boolean"},"mine":{"type":"boolean"},"name":{"anyOf":[{"type":"null"},{"type":"string"}]},"revision":{"type":"number"}},"required":["assigned","mine","name","revision"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"requesterId":{"type":"string"},"status":{"anyOf":[{"const":"closed"},{"const":"open"}]},"subject":{"type":"string"},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["assignment","createdAt","id","requesterId","status","subject","teamId","updatedAt"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"support.list"}},"/manage/support/reply":{"post":{"operationId":"support.reply","summary":"Reply in a Shuffl support conversation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string"},"messageId":{"type":"string"},"privateNote":{"anyOf":[{"const":false},{"const":true}]},"threadId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["body","threadId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"authorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"authorRole":{"anyOf":[{"const":"customer"},{"const":"email"},{"const":"operator"}]},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"privateNote":{"type":"boolean"},"providerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"threadId":{"type":"string"}},"required":["authorId","authorRole","body","createdAt","id","privateNote","providerId","teamId","threadId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"support.reply"}},"/manage/sync/connect":{"post":{"operationId":"sync.connect","summary":"Connect a directory sync provider with the credential given","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"provider":{"anyOf":[{"const":"bamboohr"},{"const":"deel"},{"const":"entra"},{"const":"google_team"},{"const":"google_workspace"},{"const":"gusto"},{"const":"hibob"},{"const":"jumpcloud"},{"const":"justworks"},{"const":"okta"},{"const":"onelogin"},{"const":"personio"},{"const":"rippling"},{"const":"scim"},{"const":"slack"},{"const":"workday"}]},"confirm":{"const":"sync.connect"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["fields","provider","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"connectionId":{"type":"string"},"first":{"anyOf":[{"type":"object","properties":{"error":{"not":{}},"status":{"const":"skipped"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"string"},"status":{"const":"failed"}},"required":["error","status"],"additionalProperties":false},{"type":"object","properties":{"created":{"type":"number"},"ended":{"type":"number"},"error":{"not":{}},"linked":{"type":"number"},"managers":{"type":"number"},"missing":{"type":"number"},"skipped":{"type":"number"},"status":{"const":"completed"},"suspended":{"type":"number"},"unchanged":{"type":"number"},"units":{"type":"number"},"updated":{"type":"number"}},"required":["created","ended","linked","managers","missing","skipped","status","suspended","unchanged","units","updated"],"additionalProperties":false}]}},"required":["connectionId","first"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"sync.connect"}},"/manage/sync/current":{"post":{"operationId":"sync.current","summary":"Read the People sync provider, its last sync and what it found","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{"type":"array","items":{"type":"object","properties":{"auth":{"anyOf":[{"type":"object","properties":{"kind":{"const":"scim"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"installation"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"help":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"optional":{"anyOf":[{"const":false},{"const":true}]},"placeholder":{"type":"string"},"secret":{"type":"boolean"}},"required":["help","id","label","secret"],"additionalProperties":false}},"kind":{"const":"api_key"},"steps":{"type":"array","items":{"type":"string"}}},"required":["fields","kind","steps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"oauth"},"steps":{"type":"array","items":{"type":"string"}}},"required":["kind","steps"],"additionalProperties":false}]},"availability":{"anyOf":[{"type":"object","properties":{"state":{"const":"available"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"note":{"type":"string"},"state":{"const":"partner_pending"}},"required":["note","state"],"additionalProperties":false},{"type":"object","properties":{"note":{"type":"string"},"state":{"const":"coming_soon"}},"required":["state"],"additionalProperties":false}]},"blurb":{"type":"string"},"capabilities":{"type":"object","properties":{"deactivation":{"type":"boolean"},"departments":{"type":"boolean"},"managers":{"type":"boolean"},"people":{"type":"boolean"},"startDates":{"type":"boolean"},"teams":{"type":"boolean"},"timeOffBalances":{"anyOf":[{"const":false},{"const":true}]},"titles":{"type":"boolean"},"webhooks":{"type":"boolean"}},"required":["deactivation","departments","managers","people","startDates","teams","titles","webhooks"],"additionalProperties":false},"category":{"anyOf":[{"const":"chat"},{"const":"hris"},{"const":"identity"}]},"docsHref":{"type":"string"},"id":{"anyOf":[{"const":"bamboohr"},{"const":"deel"},{"const":"entra"},{"const":"google_team"},{"const":"google_workspace"},{"const":"gusto"},{"const":"hibob"},{"const":"jumpcloud"},{"const":"justworks"},{"const":"okta"},{"const":"onelogin"},{"const":"personio"},{"const":"rippling"},{"const":"scim"},{"const":"slack"},{"const":"workday"}]},"name":{"type":"string"},"via":{"const":"scim"}},"required":["auth","availability","blurb","capabilities","category","id","name"],"additionalProperties":false}},"connections":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastSyncAt":{"anyOf":[{"type":"null"},{"type":"string"}]},"live":{"type":"boolean"},"manage":{"anyOf":[{"type":"null"},{"const":"scim"},{"const":"slack"}]},"people":{"type":"number"},"provider":{"type":"string"},"runs":{"type":"array","items":{"type":"object","properties":{"counts":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"errorCode":{"anyOf":[{"type":"null"},{"type":"string"}]},"finishedAt":{"anyOf":[{"type":"null"},{"type":"string"}]},"id":{"type":"string"},"startedAt":{"type":"string"},"status":{"type":"string"},"trigger":{"type":"string"}},"required":["counts","errorCode","finishedAt","id","startedAt","status","trigger"],"additionalProperties":false}},"status":{"anyOf":[{"const":"connected"},{"const":"disconnected"},{"const":"needs_attention"}]}},"required":["createdAt","id","label","lastSyncAt","live","manage","people","provider","runs","status"],"additionalProperties":false}},"organizationId":{"type":"string"},"requests":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string"},"name":{"type":"string"}},"required":["createdAt","name"],"additionalProperties":false}},"scimAvailable":{"type":"boolean"}},"required":["catalog","connections","organizationId","requests","scimAvailable"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"sync.current"}},"/manage/sync/disconnect":{"post":{"operationId":"sync.disconnect","summary":"Disconnect this directory sync provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"confirm":{"const":"sync.disconnect"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["connectionId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"disconnected":{"type":"boolean"}},"required":["disconnected"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"sync.disconnect"}},"/manage/sync/request":{"post":{"operationId":"sync.request","summary":"Ask for a People sync provider Shuffl does not support yet","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"requested":{"type":"boolean"}},"required":["requested"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"sync.request"}},"/manage/sync/run":{"post":{"operationId":"sync.run","summary":"Sync People from the connected provider now","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["connectionId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"sync.run"}},"/manage/team/answerMinutes":{"post":{"operationId":"team.answerMinutes","summary":"Set the team estimate of minutes per HR question, used for time saved","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"minutes":{"anyOf":[{"type":"null"},{"type":"number"}]},"confirm":{"const":"team.answerMinutes"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["minutes","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"minutes":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["minutes"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"team.answerMinutes"}},"/manage/team/dismissLaunchPost":{"post":{"operationId":"team.dismissLaunchPost","summary":"Dismiss the Tell your team what they can ask post on Today for everyone","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"anyOf":[{"const":"dismissed"},{"const":"posted"}]},"confirm":{"const":"team.dismissLaunchPost"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["reason","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"dismissed":{"type":"boolean"}},"required":["dismissed"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"team.dismissLaunchPost"}},"/manage/team/launchPost":{"post":{"operationId":"team.launchPost","summary":"Read the launch announcement for the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dismissed":{"type":"boolean"}},"required":["dismissed"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"team.launchPost"}},"/manage/teams/connectionPermissions":{"post":{"operationId":"teams.connectionPermissions","summary":"List connections whose permissions are behind what Shuffl asks for","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"blocking":{"type":"boolean"},"features":{"type":"array","items":{"type":"string"}},"missingScopes":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"provider":{"const":"slack"}},"required":["blocking","features","missingScopes","name","provider"],"additionalProperties":false}},"signature":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["connections","signature"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.connectionPermissions"}},"/manage/teams/discardPairHistory":{"post":{"operationId":"teams.discardPairHistory","summary":"Remove this staged past-intros report","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string"},"confirm":{"const":"teams.discardPairHistory"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["importId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"discarded":{"const":true},"id":{"type":"string"}},"required":["discarded","id"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.discardPairHistory"}},"/manage/teams/initialize":{"post":{"operationId":"teams.initialize","summary":"Finish setting up a new workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"ready":{"type":"boolean"}},"required":["ready"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.initialize"}},"/manage/teams/moveSlackChannels":{"post":{"operationId":"teams.moveSlackChannels","summary":"Set up each channel in Shuffl: paused intros, praise and celebrations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"choices":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"use":{"anyOf":[{"const":"celebrations"},{"const":"intros"},{"const":"shoutouts"},{"const":"skip"}]}},"required":["channelId","use"],"additionalProperties":false}},"timezone":{"type":"string"},"confirm":{"const":"teams.moveSlackChannels"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["choices","timezone","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"detected":{"type":"number"},"pairHistory":{"type":"object","properties":{"files":{"type":"number"},"pairs":{"type":"number"}},"required":["files","pairs"],"additionalProperties":false},"praiseChannelMax":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"string"},"name":{"type":"string"},"outcome":{"anyOf":[{"const":"already"},{"const":"created"},{"const":"failed"},{"const":"invite_required"},{"const":"limit"}]},"use":{"anyOf":[{"const":"celebrations"},{"const":"intros"},{"const":"shoutouts"}]}},"required":["channelId","name","outcome","use"],"additionalProperties":false}}},"required":["detected","pairHistory","praiseChannelMax","results"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.moveSlackChannels"}},"/manage/teams/rename":{"post":{"operationId":"teams.rename","summary":"Rename the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["name","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.rename"}},"/manage/teams/resendSlackWelcome":{"post":{"operationId":"teams.resendSlackWelcome","summary":"Send the Slack install welcome to your own Slack DM again","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"teams.resendSlackWelcome"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.resendSlackWelcome"}},"/manage/teams/saveAgentSetup":{"post":{"operationId":"teams.saveAgentSetup","summary":"Choose the built-in assistant or an external agent for the workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"choice":{"anyOf":[{"const":"built_in"},{"const":"deferred"},{"const":"external"}]},"protocol":{"anyOf":[{"type":"null"},{"const":"api"},{"const":"mcp"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["choice","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"boolean"},"choice":{"anyOf":[{"const":"built_in"},{"const":"deferred"},{"const":"external"}]},"protocol":{"anyOf":[{"type":"null"},{"const":"api"},{"const":"mcp"}]},"saved":{"type":"boolean"},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["changed","choice","protocol","saved","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.saveAgentSetup"}},"/manage/teams/saveSlackJoinAccess":{"post":{"operationId":"teams.saveSlackJoinAccess","summary":"Choose whether Slack members can join Shuffl on their own","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["enabled","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"enabled":{"type":"boolean"},"saved":{"type":"boolean"}},"required":["enabled","saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.saveSlackJoinAccess"}},"/manage/teams/saveSlackProfileLink":{"post":{"operationId":"teams.saveSlackProfileLink","summary":"Turn the Shuffl profile link on Slack profiles on or off","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["enabled","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"enabled":{"type":"boolean"},"saved":{"type":"boolean"}},"required":["enabled","saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.saveSlackProfileLink"}},"/manage/teams/setup":{"post":{"operationId":"teams.setup","summary":"Read the workspace's setup checklist","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"access":{"anyOf":[{"type":"object","properties":{"allowed":{"type":"boolean"},"mode":{"const":"unenforced"},"reason":{"type":"string"}},"required":["allowed","mode","reason"],"additionalProperties":false},{"type":"object","properties":{"allowed":{"type":"boolean"},"mode":{"const":"company"},"reason":{"type":"string"}},"required":["allowed","mode","reason"],"additionalProperties":false}]},"agentSetup":{"type":"object","properties":{"choice":{"anyOf":[{"type":"null"},{"const":"built_in"},{"const":"deferred"},{"const":"external"}]},"protocol":{"anyOf":[{"type":"null"},{"const":"api"},{"const":"mcp"}]},"updatedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]}},"required":["choice","protocol","updatedAt"],"additionalProperties":false},"billing":{"type":"object","properties":{"available":{"type":"boolean"},"initialized":{"type":"boolean"},"status":{"type":"string"}},"required":["available","initialized","status"],"additionalProperties":false},"celebrations":{"type":"object","properties":{"enabled":{"type":"number"}},"required":["enabled"],"additionalProperties":false},"communities":{"type":"object","properties":{"count":{"type":"number"}},"required":["count"],"additionalProperties":false},"employees":{"type":"object","properties":{"awaitingAccess":{"type":"number"},"enabled":{"type":"number"},"expiredInvitations":{"type":"number"},"pendingInvitations":{"type":"number"},"ready":{"type":"boolean"}},"required":["awaitingAccess","enabled","expiredInvitations","pendingInvitations","ready"],"additionalProperties":false},"hr":{"anyOf":[{"type":"object","properties":{"ready":{"type":"boolean"},"reason":{"const":"no_destination"},"responderCount":{"type":"number"}},"required":["ready","reason","responderCount"],"additionalProperties":false},{"type":"object","properties":{"ready":{"type":"boolean"},"reason":{"const":"no_active_responders"},"responderCount":{"type":"number"}},"required":["ready","reason","responderCount"],"additionalProperties":false},{"type":"object","properties":{"ready":{"type":"boolean"},"responderCount":{"type":"number"}},"required":["ready","responderCount"],"additionalProperties":false}]},"knowledge":{"type":"object","properties":{"approved":{"type":"number"},"ready":{"type":"boolean"}},"required":["approved","ready"],"additionalProperties":false},"local":{"type":"boolean"},"organizationId":{"type":"string"},"preview":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"configured":{"type":"boolean"},"ready":{"type":"boolean"}},"required":["completedAt","configured","ready"],"additionalProperties":false},"programs":{"type":"object","properties":{"connections":{"type":"number"},"onboarding":{"type":"number"},"pulse":{"anyOf":[{"const":"active"},{"const":"draft"},{"const":"paused"}]}},"required":["connections","onboarding","pulse"],"additionalProperties":false},"progress":{"type":"object","properties":{"ready":{"type":"number"},"total":{"type":"number"}},"required":["ready","total"],"additionalProperties":false},"slack":{"type":"object","properties":{"available":{"type":"boolean"},"connected":{"type":"boolean"},"missingScopes":{"type":"array","items":{"type":"string"}},"ready":{"type":"boolean"},"status":{"anyOf":[{"const":"connected"},{"const":"incomplete"},{"const":"local_fixture"},{"const":"permissions_required"},{"const":"revoked"}]}},"required":["available","connected","missingScopes","ready","status"],"additionalProperties":false},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"const":"access"},{"const":"celebrations"},{"const":"communities"},{"const":"connections"},{"const":"employees"},{"const":"hr"},{"const":"knowledge"},{"const":"onboarding"},{"const":"preview"},{"const":"pulse"},{"const":"slack"}]},"ready":{"type":"boolean"},"required":{"type":"boolean"},"title":{"type":"string"}},"required":["id","ready","required","title"],"additionalProperties":false}},"teamName":{"type":"string"}},"required":["access","agentSetup","billing","celebrations","communities","employees","hr","knowledge","local","organizationId","preview","programs","progress","slack","steps","teamName"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.setup"}},"/manage/teams/slackChannels":{"post":{"operationId":"teams.slackChannels","summary":"List community channels in the connected Slack and what each would become","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"connected":{"anyOf":[{"type":"null"},{"const":"celebrations"},{"const":"intros"},{"const":"shoutouts"},{"const":"skip"}]},"fromApp":{"type":"boolean"},"guess":{"anyOf":[{"const":"celebrations"},{"const":"intros"},{"const":"shoutouts"},{"const":"skip"},{"const":"watercooler"}]},"id":{"type":"string"},"isMember":{"type":"boolean"},"isPrivate":{"type":"boolean"},"joinable":{"type":"boolean"},"name":{"type":"string"}},"required":["connected","fromApp","guess","id","isMember","isPrivate","joinable","name"],"additionalProperties":false}},"pairHistory":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"id":{"type":"string"},"intros":{"type":"number"},"pairs":{"type":"number"},"people":{"type":"number"},"rows":{"type":"number"},"skipped":{"type":"number"},"status":{"anyOf":[{"const":"applied"},{"const":"staged"}]},"via":{"anyOf":[{"const":"agent"},{"const":"web"}]}},"required":["createdAt","fileName","id","intros","pairs","people","rows","skipped","status","via"],"additionalProperties":false}},"status":{"anyOf":[{"const":"found"},{"const":"not_found"},{"const":"unavailable"}]}},"required":["channels","pairHistory","status"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.slackChannels"}},"/manage/teams/slackJoinAccess":{"post":{"operationId":"teams.slackJoinAccess","summary":"Read whether Slack members can join Shuffl on their own","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"changedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"enabled":{"type":"boolean"}},"required":["changedAt","enabled"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.slackJoinAccess"}},"/manage/teams/slackProfileLink":{"post":{"operationId":"teams.slackProfileLink","summary":"Read the Shuffl profile link setting for Slack profiles","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"changedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"enabled":{"type":"boolean"},"field":{"anyOf":[{"const":"found"},{"const":"missing"},{"const":"unknown"}]},"grant":{"anyOf":[{"const":"not_connected"},{"const":"ready"},{"const":"reconnect"}]},"lastSync":{"anyOf":[{"type":"null"},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"cleared":{"type":"number"},"outcome":{"type":"string"},"set":{"type":"number"},"skipped":{"type":"number"}},"required":["at","cleared","outcome","set","skipped"],"additionalProperties":false}]},"pending":{"type":"boolean"},"plan":{"anyOf":[{"const":"free"},{"const":"paid"},{"const":"unknown"}]},"remaining":{"type":"number"}},"required":["changedAt","enabled","field","grant","lastSync","pending","plan","remaining"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.slackProfileLink"}},"/manage/teams/status":{"post":{"operationId":"teams.status","summary":"Pause or resume the whole workspace","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"anyOf":[{"const":"active"},{"const":"paused"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["status","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"status":{"anyOf":[{"const":"active"},{"const":"paused"}]}},"required":["status"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.status"}},"/manage/teams/syncSlackProfileLinks":{"post":{"operationId":"teams.syncSlackProfileLinks","summary":"Write the Shuffl profile link to every Slack profile again","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"teams.syncSlackProfileLinks"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.syncSlackProfileLinks"}},"/manage/teams/uploadPairHistory":{"post":{"operationId":"teams.uploadPairHistory","summary":"Stage this past-intros report for the switch; nothing changes until it is applied","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string"},"fileName":{"type":"string"},"confirm":{"const":"teams.uploadPairHistory"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["csv","fileName","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"duplicate":{"type":"boolean"},"fileName":{"type":"string"},"id":{"type":"string"},"intros":{"type":"number"},"pairs":{"type":"number"},"people":{"type":"number"},"rows":{"type":"number"},"skipped":{"type":"number"},"status":{"anyOf":[{"const":"applied"},{"const":"staged"}]},"via":{"anyOf":[{"const":"agent"},{"const":"web"}]}},"required":["createdAt","duplicate","fileName","id","intros","pairs","people","rows","skipped","status","via"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"teams.uploadPairHistory"}},"/team":{"get":{"operationId":"teams.current","summary":"Get the team bound to this token","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string"},"role":{"type":"string"}},"required":["id","name","role"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"teams.current"}},"/manage/timeOff/balances":{"post":{"operationId":"timeOff.balances","summary":"Read your own time-off balances from the connected HR system","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"connected":{"const":false},"providerName":{"anyOf":[{"type":"null"},{"type":"string"}]},"reason":{"anyOf":[{"const":"no_person"},{"const":"not_linked"},{"const":"unauthorized"},{"const":"unavailable"}]}},"required":["connected","providerName","reason"],"additionalProperties":false},{"type":"object","properties":{"asOf":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"available":{"anyOf":[{"type":"null"},{"type":"number"}]},"pending":{"anyOf":[{"type":"null"},{"type":"number"}]},"policy":{"type":"string"},"unit":{"anyOf":[{"const":"days"},{"const":"hours"}]},"used":{"anyOf":[{"type":"null"},{"type":"number"}]}},"required":["available","pending","policy","unit","used"],"additionalProperties":false}},"connected":{"const":true},"provider":{"anyOf":[{"const":"bamboohr"},{"const":"deel"},{"const":"entra"},{"const":"google_team"},{"const":"google_workspace"},{"const":"gusto"},{"const":"hibob"},{"const":"jumpcloud"},{"const":"justworks"},{"const":"okta"},{"const":"onelogin"},{"const":"personio"},{"const":"rippling"},{"const":"scim"},{"const":"slack"},{"const":"workday"}]},"providerName":{"type":"string"}},"required":["asOf","balances","connected","provider","providerName"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"timeOff.balances"}},"/manage/units/archive":{"post":{"operationId":"units.archive","summary":"Archive a team or department in the People directory","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"id":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","id","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"units.archive"}},"/manage/units/list":{"post":{"operationId":"units.list","summary":"List the teams and departments in the People directory","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"archived":{"anyOf":[{"const":false},{"const":true}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"members":{"type":"number"},"unit":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"createdAt":{"type":"string","format":"date-time"},"hrTeam":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"},"revision":{"type":"number"},"teamId":{"type":"string"}},"required":["archivedAt","createdAt","hrTeam","id","kind","name","revision","teamId"],"additionalProperties":false}},"required":["members","unit"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"units.list"}},"/manage/units/save":{"post":{"operationId":"units.save","summary":"Create or rename a team or department in the People directory","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"number"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["expectedRevision","id","kind","name","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"createdAt":{"type":"string","format":"date-time"},"hrTeam":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"},"revision":{"type":"number"},"teamId":{"type":"string"}},"required":["archivedAt","createdAt","hrTeam","id","kind","name","revision","teamId"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"units.save"}},"/manage/users/activity":{"post":{"operationId":"users.activity","summary":"Read a person's recent activity in Shuffl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"connections":{"type":"object","properties":{"introductions":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"program":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"runId":{"type":"string"},"with":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}},"required":["at","program","runId","with"],"additionalProperties":false}},"programs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"stats":{"type":"object","properties":{"introductions":{"type":"number"},"lastIntroductionAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"people":{"type":"number"},"programs":{"type":"number"}},"required":["introductions","lastIntroductionAt","people","programs"],"additionalProperties":false}},"required":["introductions","programs","stats"],"additionalProperties":false},"events":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"kind":{"const":"onboarding_started"},"program":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["at","kind","program"],"additionalProperties":false},{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"kind":{"const":"onboarding_completed"},"program":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["at","kind","program"],"additionalProperties":false},{"type":"object","properties":{"accepted":{"type":"boolean"},"at":{"type":"string","format":"date-time"},"hire":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"kind":{"const":"buddy_response"},"program":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["accepted","at","hire","kind","program"],"additionalProperties":false},{"type":"object","properties":{"action":{"anyOf":[{"const":"hr.responder_granted"},{"const":"hr.responder_revoked"},{"const":"knowledge.verifier_granted"},{"const":"knowledge.verifier_revoked"},{"const":"participant.opted_in"},{"const":"participant.opted_out"},{"const":"person.access_suspended"},{"const":"person.access_updated"},{"const":"person.role_updated"}]},"at":{"type":"string","format":"date-time"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"anyOf":[{},{"type":"null"}]}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}]}}]}},"kind":{"const":"audit"},"program":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]}},"required":["action","at","details","kind","program"],"additionalProperties":false}]}},"hrRequests":{"anyOf":[{"type":"null"},{"type":"object","properties":{"open":{"type":"number"},"total":{"type":"number"}},"required":["open","total"],"additionalProperties":false}]}},"required":["connections","events","hrRequests"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.activity"}},"/manage/users/assignManagers":{"post":{"operationId":"users.assignManagers","summary":"Set the manager of several people at once","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignments":{"type":"array","items":{"type":"object","properties":{"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"personId":{"type":"string"}},"required":["managerId","personId"],"additionalProperties":false}},"confirm":{"const":"users.assignManagers"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["assignments","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"changed":{"type":"number"},"unchanged":{"type":"number"}},"required":["changed","unchanged"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.assignManagers"}},"/manage/users/blockedPairs":{"post":{"operationId":"users.blockedPairs","summary":"List pairs of people who are never introduced","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"a":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"b":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["a","b"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.blockedPairs"}},"/manage/users/blockPair":{"post":{"operationId":"users.blockPair","summary":"Stop two people from being introduced to each other","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"a":{"type":"string"},"b":{"type":"string"},"blocked":{"type":"boolean"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["a","b","blocked","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.blockPair"}},"/manage/users/details":{"post":{"operationId":"users.details","summary":"Read one person's People directory record","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"memberId":{"type":"string"}},"required":["memberId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"directory":{"anyOf":[{"type":"null"},{"type":"object","properties":{"employmentType":{"anyOf":[{"type":"null"},{"const":"contractor"},{"const":"full_time"},{"const":"intern"},{"const":"part_time"},{"const":"temporary"}]},"jobTitle":{"anyOf":[{"type":"null"},{"type":"string"}]},"managedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"managedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"memberId":{"type":"string"},"revision":{"type":"number"},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["employmentType","jobTitle","managedAt","managedBy","managerId","memberId","revision","startDate","teamId","timezone","updatedAt"],"additionalProperties":false}]},"manager":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false},"units":{"type":"array","items":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"hrTeam":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"}},"required":["archivedAt","hrTeam","id","kind","name"],"additionalProperties":false}}},"required":["directory","manager","member","units"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.details"}},"/manage/users/filterOptions":{"post":{"operationId":"users.filterOptions","summary":"List the teams, departments, managers and locations People can filter by","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"string"}},"managers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"timezones":{"type":"array","items":{"type":"string"}},"titles":{"type":"array","items":{"type":"string"}},"units":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"}},"required":["id","kind","name"],"additionalProperties":false}}},"required":["locations","managers","timezones","titles","units"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.filterOptions"}},"/manage/users/managerHistory":{"post":{"operationId":"users.managerHistory","summary":"Read a person's recorded manager history","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"string"},"memberId":{"type":"string"}},"required":["memberId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"actorId":{"anyOf":[{"type":"null"},{"type":"string"}]},"details":{"type":"object","properties":{"actorName":{"type":"string"},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"managerName":{"anyOf":[{"type":"null"},{"type":"string"}]},"previousManagerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"previousManagerName":{"anyOf":[{"type":"null"},{"type":"string"}]},"previousRecorded":{"type":"boolean"},"revision":{"type":"number"}},"required":["actorName","managerId","managerName","previousManagerId","previousManagerName","previousRecorded","revision"],"additionalProperties":false},"id":{"type":"string"},"recordedAt":{"type":"string","format":"date-time"}},"required":["actorId","details","id","recordedAt"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.managerHistory"}},"/manage/users/managers":{"post":{"operationId":"users.managers","summary":"List the managers in the People directory","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"excludeId":{"type":"string"},"search":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.managers"}},"/manage/users/page":{"post":{"operationId":"users.page","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","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"anyOf":[{"const":"all"},{"const":"enabled"},{"const":"pending"},{"const":"suspended"}]},"departmentId":{"type":"string"},"directoryTeamId":{"type":"string"},"directReports":{"anyOf":[{"const":"all"},{"const":"no"},{"const":"yes"}]},"hasManager":{"anyOf":[{"const":"all"},{"const":"no"},{"const":"yes"}]},"jobTitle":{"type":"string"},"location":{"type":"string"},"managerId":{"type":"string"},"page":{"type":"number"},"programId":{"type":"string"},"role":{"anyOf":[{"const":"admin"},{"const":"all"},{"const":"hr_responder"},{"const":"knowledge_verifier"},{"const":"member"},{"const":"owner"}]},"search":{"type":"string"},"slackAccount":{"anyOf":[{"const":"all"},{"const":"linked"},{"const":"unlinked"}]},"status":{"anyOf":[{"const":"all"},{"const":"inactive"},{"const":"participating"},{"const":"paused"}]},"timezone":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"notInvited":{"type":"number"},"ownPersonId":{"anyOf":[{"type":"null"},{"type":"string"}]},"page":{"type":"number"},"pageSize":{"type":"number"},"rows":{"type":"array","items":{"type":"object","properties":{"access":{"anyOf":[{"type":"null"},{"type":"object","properties":{"status":{"anyOf":[{"const":"enabled"},{"const":"pending"},{"const":"suspended"}]}},"required":["status"],"additionalProperties":false}]},"appAccess":{"anyOf":[{"type":"null"},{"const":"access_pending"},{"const":"active"},{"const":"invited"},{"const":"no_email"},{"const":"not_invited"},{"const":"suspended"}]},"enrollment":{"anyOf":[{"type":"null"},{"type":"object","properties":{"optedIn":{"type":"boolean"},"present":{"type":"boolean"}},"required":["optedIn","present"],"additionalProperties":false}]},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false},"photoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamRole":{"anyOf":[{"type":"null"},{"const":"admin"},{"const":"member"},{"const":"owner"}]},"units":{"type":"array","items":{"type":"object","properties":{"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"}},"required":["kind","name"],"additionalProperties":false}},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["access","appAccess","enrollment","member","photoUrl","teamRole","units","userId"],"additionalProperties":false}},"total":{"type":"number"}},"required":["notInvited","ownPersonId","page","pageSize","rows","total"],"additionalProperties":false}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.page"}},"/manage/users/participants":{"post":{"operationId":"users.participants","summary":"List the people who take part in programs","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"programId":{"type":"string"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"enrollment":{"type":"object","properties":{"breakUntil":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"consentRevision":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"memberId":{"type":"string"},"optedIn":{"type":"boolean"},"present":{"type":"boolean"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["breakUntil","consentRevision","createdAt","memberId","optedIn","present","programId","reason","teamId","updatedAt"],"additionalProperties":false},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false}},"required":["enrollment","member"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"enrollment":{"type":"null"},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false}},"required":["enrollment","member"],"additionalProperties":false}}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.participants"}},"/manage/users/participation":{"post":{"operationId":"users.participation","summary":"Opt a person in to or out of a program","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"memberId":{"type":"string"},"optedIn":{"type":"boolean"},"programId":{"type":"string"},"reason":{"type":"string"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["memberId","optedIn","programId","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"breakUntil":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"consentRevision":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"memberId":{"type":"string"},"optedIn":{"type":"boolean"},"present":{"type":"boolean"},"programId":{"type":"string"},"reason":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}},"required":["breakUntil","consentRevision","createdAt","memberId","optedIn","present","programId","reason","teamId","updatedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.participation"}},"/manage/users/profile":{"post":{"operationId":"users.profile","summary":"Edit a person's profile as an administrator","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"memberId":{"type":"string"},"profile":{"type":"object","properties":{"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"}},"additionalProperties":false},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["memberId","profile","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"saved":{"type":"boolean"}},"required":["saved"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.profile"}},"/manage/users/proposeReportingLines":{"post":{"operationId":"users.proposeReportingLines","summary":"Ask Mello to propose managers for people without one; nothing changes until reviewed","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirm":{"const":"users.proposeReportingLines"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"anyOf":[{"type":"object","properties":{"proposal":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inferredBy":{"anyOf":[{"const":"ai"},{"const":"rule"}]},"lines":{"type":"array","items":{"type":"object","properties":{"manager":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","title"],"additionalProperties":false},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","title"],"additionalProperties":false},"reason":{"type":"string"}},"required":["manager","person","reason"],"additionalProperties":false}}},"required":["createdAt","id","inferredBy","lines"],"additionalProperties":false},"status":{"const":"proposed"}},"required":["proposal","status"],"additionalProperties":false},{"type":"object","properties":{"status":{"anyOf":[{"const":"not_enough_to_go_on"},{"const":"nothing_missing"}]}},"required":["status"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.proposeReportingLines"}},"/manage/users/reportingLineProposal":{"post":{"operationId":"users.reportingLineProposal","summary":"Read the reporting lines Mello proposed that wait for review","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"null"},{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"inferredBy":{"anyOf":[{"const":"ai"},{"const":"rule"}]},"lines":{"type":"array","items":{"type":"object","properties":{"manager":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","title"],"additionalProperties":false},"person":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["id","name","title"],"additionalProperties":false},"reason":{"type":"string"}},"required":["manager","person","reason"],"additionalProperties":false}}},"required":["createdAt","id","inferredBy","lines"],"additionalProperties":false}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.reportingLineProposal"}},"/manage/users/reviewReportingLines":{"post":{"operationId":"users.reviewReportingLines","summary":"Approve chosen proposed reporting lines and close the proposal","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"approve":{"type":"array","items":{"type":"string"}},"proposalId":{"type":"string"},"confirm":{"const":"users.reviewReportingLines"},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["approve","proposalId","confirm","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"approved":{"type":"number"},"rejected":{"type":"number"}},"required":["approved","rejected"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.reviewReportingLines"}},"/manage/users/save":{"post":{"operationId":"users.save","summary":"Change someone's People directory record as an administrator: name, job title, manager, team, department or start date","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowDuplicateEmail":{"anyOf":[{"const":false},{"const":true}]},"departmentId":{"anyOf":[{"type":"null"},{"type":"string"}]},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employmentType":{"anyOf":[{"type":"null"},{"const":"contractor"},{"const":"full_time"},{"const":"intern"},{"const":"part_time"},{"const":"temporary"}]},"expectedRevision":{"type":"number"},"jobTitle":{"anyOf":[{"type":"null"},{"type":"string"}]},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"memberId":{"type":"string"},"name":{"type":"string"},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamIds":{"type":"array","items":{"type":"string"}},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"requestKey":{"type":"string","minLength":1,"maxLength":128}},"required":["departmentId","email","expectedRevision","jobTitle","managerId","memberId","name","startDate","teamIds","timezone","requestKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]},"result":{"anyOf":[{"type":"object","properties":{"directory":{"anyOf":[{"type":"null"},{"type":"object","properties":{"employmentType":{"anyOf":[{"type":"null"},{"const":"contractor"},{"const":"full_time"},{"const":"intern"},{"const":"part_time"},{"const":"temporary"}]},"jobTitle":{"anyOf":[{"type":"null"},{"type":"string"}]},"managedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"managedBy":{"anyOf":[{"type":"null"},{"type":"string"}]},"managerId":{"anyOf":[{"type":"null"},{"type":"string"}]},"memberId":{"type":"string"},"revision":{"type":"number"},"startDate":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"timezone":{"anyOf":[{"type":"null"},{"type":"string"}]},"updatedAt":{"type":"string","format":"date-time"}},"required":["employmentType","jobTitle","managedAt","managedBy","managerId","memberId","revision","startDate","teamId","timezone","updatedAt"],"additionalProperties":false}]},"manager":{"anyOf":[{"type":"null"},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}]},"member":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"email":{"anyOf":[{"type":"null"},{"type":"string"}]},"employeeNumber":{"anyOf":[{"type":"null"},{"type":"number"}]},"id":{"type":"string"},"name":{"type":"string"},"profile":{"type":"object","properties":{"askMeAbout":{"type":"array","items":{"type":"string"}},"asks":{"type":"string"},"bio":{"type":"string"},"interests":{"type":"string"},"location":{"type":"string"},"offers":{"type":"string"},"phone":{"type":"string"},"pronouns":{"type":"string"},"role":{"type":"string"},"workingOn":{"type":"string"}},"additionalProperties":false},"slackPhotoUrl":{"anyOf":[{"type":"null"},{"type":"string"}]},"slackProfileLinkAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"slackUserId":{"anyOf":[{"type":"null"},{"type":"string"}]},"teamId":{"type":"string"},"userId":{"anyOf":[{"type":"null"},{"type":"string"}]}},"required":["active","bot","createdAt","email","employeeNumber","id","name","profile","slackPhotoUrl","slackProfileLinkAt","slackUserId","teamId","userId"],"additionalProperties":false},"units":{"type":"array","items":{"type":"object","properties":{"archivedAt":{"anyOf":[{"type":"null"},{"type":"string","format":"date-time"}]},"hrTeam":{"type":"boolean"},"id":{"type":"string"},"kind":{"anyOf":[{"const":"department"},{"const":"team"}]},"name":{"type":"string"}},"required":["archivedAt","hrTeam","id","kind","name"],"additionalProperties":false}}},"required":["directory","manager","member","units"],"additionalProperties":false},{"type":"null"}]}},"required":["receipt","result"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"write","x-shuffl-permission":"users.save"}},"/users/{id}":{"get":{"operationId":"users.get","summary":"Get a person","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string"},"profile":{"type":"object","properties":{"asks":{"type":"string","maxLength":500},"bio":{"type":"string","maxLength":1000},"interests":{"type":"string","maxLength":500},"location":{"type":"string","maxLength":200},"offers":{"type":"string","maxLength":500},"phone":{"type":"string","maxLength":40},"pronouns":{"type":"string","maxLength":40},"role":{"type":"string","maxLength":200}}}},"required":["active","bot","email","id","name","profile"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.get"}},"/users":{"get":{"operationId":"users.list","summary":"List people in this team","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","minLength":1,"maxLength":128},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"allowEmptyValue":true,"allowReserved":true},{"name":"search","in":"query","schema":{"type":"string","maxLength":100},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean"},"bot":{"type":"boolean"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string"},"profile":{"type":"object","properties":{"asks":{"type":"string","maxLength":500},"bio":{"type":"string","maxLength":1000},"interests":{"type":"string","maxLength":500},"location":{"type":"string","maxLength":200},"offers":{"type":"string","maxLength":500},"phone":{"type":"string","maxLength":40},"pronouns":{"type":"string","maxLength":40},"role":{"type":"string","maxLength":200}}}},"required":["active","bot","email","id","name","profile"]}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["items","nextCursor"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"users.list"}},"/channels":{"get":{"operationId":"channels.list","summary":"List Slack channels available to Shuffl","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"isMember":{"type":"boolean"},"isPrivate":{"type":"boolean"},"name":{"type":"string"},"readiness":{"enum":["ready","invite_required","missing_scope"],"type":"string"}},"required":["id","isMember","isPrivate","name","readiness"]}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"channels.list"}},"/commands/{id}":{"get":{"operationId":"commands.get","summary":"Read your own management command receipt","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"completedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"operation":{"type":"string"},"requestKey":{"type":"string"},"status":{"enum":["running","succeeded","failed","unknown"],"type":"string"}},"required":["completedAt","createdAt","id","operation","requestKey","status"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"commands.get"}},"/manager":{"get":{"operationId":"manager.current","summary":"Read the authenticated employee’s own manager context","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"href":{"type":"string"},"kind":{"enum":["knowledge","manager","directory"],"type":"string"},"passageId":{"type":"string"},"quote":{"type":"string"},"sourceId":{"type":"string"},"title":{"type":"string"},"versionId":{"type":"string"}},"required":["href","passageId","quote","sourceId","title","versionId"]},{"type":"null"}]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"manager.current"}},"/permissions":{"get":{"operationId":"permissions.list","summary":"Discover endpoint permissions available to this token","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{"type":"array","items":{"type":"object","properties":{"access":{"enum":["read","write"],"type":"string"},"alwaysAllowed":{"type":"boolean"},"description":{"type":"string"},"id":{"enum":["access.get","access.slackWaiting","access.enableSlack","access.save","access.saveRole","assistant.conversations","assistant.history","assistant.delete","assistant.send","assistant.stop","badges.holders","badges.list","badges.ofPerson","badges.settings","badges.award","badges.claim","badges.decideRequest","badges.generatePicture","badges.hideOwn","badges.request","badges.revoke","badges.save","badges.saveSettings","badges.setHidden","badges.uploadPicture","celebrations.card","celebrations.cards","celebrations.deliveries","celebrations.mine","celebrations.preferences","celebrations.preview","celebrations.program","celebrations.review","celebrations.refresh","celebrations.removeCardNote","celebrations.save","celebrations.savePreferences","celebrations.signCard","channels.list","commands.get","communities.channelSuggestions","communities.createCapabilities","communities.list","communities.members","communities.ofPerson","communities.archive","communities.createSlackChannel","communities.fromChannels","communities.generateCover","communities.invite","communities.join","communities.leave","communities.removeMember","communities.revokeInvitation","communities.save","communities.setVisibility","communities.sync","communities.uploadCover","credentials.api.list","credentials.api.create","credentials.api.revoke","digest.nudge","digest.nudges","digest.preview","digest.settings","digest.actOnNudge","digest.dismissNudge","digest.saveSettings","exports.team","getStarted.celebration","getStarted.get","getStarted.celebrate","getStarted.dismiss","getStarted.draftIntro","getStarted.intro","getStarted.wizard","home.feed","home.preferences","home.react","home.story","hr.categories","hr.get","hr.list","hr.readiness","hr.settings","hr.shareSources","hr.command","hr.configure","hr.deliver","hr.rebuildCategories","hr.renameTeam","hr.retryDelivery","hr.saveCategories","hr.share","identities.list","identities.slackAccounts","identities.webAccounts","identities.linkSlack","identities.linkWeb","identities.unlink","integrations.authorize","invitations.candidates","invitations.list","invitations.cancel","invitations.create","invitations.createMany","invitations.inviteDirectory","knowledge.context","knowledge.search","knowledge.connections.browse","knowledge.connections.list","knowledge.connections.requests","knowledge.connections.connect","knowledge.connections.disconnect","knowledge.connections.request","knowledge.policies.coverage","knowledge.sources.get","knowledge.sources.history","knowledge.sources.list","knowledge.sources.search","knowledge.sources.archive","knowledge.sources.changeAudience","knowledge.sources.importConnected","knowledge.sources.importWebsite","knowledge.sources.publish","knowledge.sources.refresh","knowledge.sources.restore","knowledge.sources.save","knowledge.sources.withdraw","knowledge.sources.write","knowledge.uploads.get","knowledge.uploads.appendPart","knowledge.uploads.complete","knowledge.uploads.create","knowledge.uploads.retry","manager.current","mcp.knowledge","network.mine","network.ofPerson","network.orgChart","network.claim","notifications.preferences","notifications.save","onboarding.buddySuggestions","onboarding.candidates","onboarding.enrollmentPreview","onboarding.firstDaysCheckIns","onboarding.firstDaysResults","onboarding.mine","onboarding.person","onboarding.program","onboarding.answerBuddyAsk","onboarding.answerCheckIn","onboarding.answerFirstDaysCheckIn","onboarding.approve","onboarding.askBuddy","onboarding.assignBuddy","onboarding.enroll","onboarding.previewEnrollment","onboarding.remove","onboarding.respondBuddy","onboarding.retry","onboarding.saveProgram","onboarding.update","operations.activity","operations.status","operations.dispatchInbox","operations.reconcile","permissions.list","praise.composer","praise.feed","praise.insights","praise.mine","praise.ofPerson","praise.settings","praise.addChannel","praise.removeChannel","praise.saveSettings","praise.send","praise.setDigest","praise.setHidden","profiles.get","profiles.whoKnows","profiles.draft","profiles.employeeNumber","profiles.save","profiles.settings","profiles.cover.delete","profiles.photo.delete","profiles.positions.delete","profiles.positions.save","programs.get","programs.list","programs.options","programs.people","programs.preview","programs.schedulePreview","programs.archive","programs.create","programs.joinChannel","programs.pause","programs.resume","programs.syncRoster","programs.update","pulse.actions","pulse.asked","pulse.audienceOptions","pulse.insights","pulse.latestRead","pulse.mine","pulse.program","pulse.proposals","pulse.questionDetail","pulse.questions","pulse.today","pulse.addQuestion","pulse.addTemplate","pulse.answer","pulse.createAction","pulse.decideProposal","pulse.editProposal","pulse.proposeQuestions","pulse.requestProposals","pulse.saveProgram","pulse.setQuestionAudience","pulse.setQuestionStatus","pulse.skip","pulse.updateAction","reminders.mine","reminders.settings","reminders.saveMine","reminders.saveSetting","reports.answerFeedback","reports.connections","reports.knowledge","reports.knowledgeSource","reports.melloTrial","reports.melloValue","reports.needsYou","reports.onboarding","reports.overview","reports.people","runs.details","runs.get","runs.list","runs.dispatch","runs.request","runs.retry","runs.stopKnownFailures","runs.history.get","runs.history.list","support.get","support.list","support.assign","support.close","support.create","support.reply","sync.current","sync.connect","sync.disconnect","sync.request","sync.run","team.launchPost","team.answerMinutes","team.dismissLaunchPost","teams.connectionPermissions","teams.current","teams.setup","teams.slackChannels","teams.slackJoinAccess","teams.slackProfileLink","teams.discardPairHistory","teams.initialize","teams.moveSlackChannels","teams.rename","teams.resendSlackWelcome","teams.saveAgentSetup","teams.saveSlackJoinAccess","teams.saveSlackProfileLink","teams.status","teams.syncSlackProfileLinks","teams.uploadPairHistory","timeOff.balances","units.list","units.archive","units.save","users.activity","users.blockedPairs","users.details","users.filterOptions","users.get","users.list","users.managerHistory","users.managers","users.page","users.participants","users.reportingLineProposal","users.assignManagers","users.blockPair","users.participation","users.profile","users.proposeReportingLines","users.reviewReportingLines","users.save"],"type":"string"},"resource":{"type":"string"},"scope":{"anyOf":[{"enum":["users:read","programs:read","programs:write","runs:write","runs:read","knowledge:read","manager:read","users:write","participation:write","profile:write","access:read","access:write","identities:read","identities:write","knowledge:manage","knowledge:write","integrations:read","integrations:write","hr:read","hr:write","support:read","support:write","operations:read","operations:write","operator:read","operator:write","reports:read","team:read","team:write","credentials:read","credentials:write","exports:read","assistant:read","assistant:write","onboarding:read","onboarding:write","celebrations:read","celebrations:write","self:read","self:write","pulse:read","pulse:write","praise:read","praise:write"],"type":"string"},{"type":"null"}]},"grantable":{"type":"boolean"},"granted":{"type":"boolean"}},"required":["access","alwaysAllowed","description","id","resource","scope","grantable","granted"]}},"permissions":{"type":"array","items":{"enum":["access.get","access.slackWaiting","access.enableSlack","access.save","access.saveRole","assistant.conversations","assistant.history","assistant.delete","assistant.send","assistant.stop","badges.holders","badges.list","badges.ofPerson","badges.settings","badges.award","badges.claim","badges.decideRequest","badges.generatePicture","badges.hideOwn","badges.request","badges.revoke","badges.save","badges.saveSettings","badges.setHidden","badges.uploadPicture","celebrations.card","celebrations.cards","celebrations.deliveries","celebrations.mine","celebrations.preferences","celebrations.preview","celebrations.program","celebrations.review","celebrations.refresh","celebrations.removeCardNote","celebrations.save","celebrations.savePreferences","celebrations.signCard","channels.list","commands.get","communities.channelSuggestions","communities.createCapabilities","communities.list","communities.members","communities.ofPerson","communities.archive","communities.createSlackChannel","communities.fromChannels","communities.generateCover","communities.invite","communities.join","communities.leave","communities.removeMember","communities.revokeInvitation","communities.save","communities.setVisibility","communities.sync","communities.uploadCover","credentials.api.list","credentials.api.create","credentials.api.revoke","digest.nudge","digest.nudges","digest.preview","digest.settings","digest.actOnNudge","digest.dismissNudge","digest.saveSettings","exports.team","getStarted.celebration","getStarted.get","getStarted.celebrate","getStarted.dismiss","getStarted.draftIntro","getStarted.intro","getStarted.wizard","home.feed","home.preferences","home.react","home.story","hr.categories","hr.get","hr.list","hr.readiness","hr.settings","hr.shareSources","hr.command","hr.configure","hr.deliver","hr.rebuildCategories","hr.renameTeam","hr.retryDelivery","hr.saveCategories","hr.share","identities.list","identities.slackAccounts","identities.webAccounts","identities.linkSlack","identities.linkWeb","identities.unlink","integrations.authorize","invitations.candidates","invitations.list","invitations.cancel","invitations.create","invitations.createMany","invitations.inviteDirectory","knowledge.context","knowledge.search","knowledge.connections.browse","knowledge.connections.list","knowledge.connections.requests","knowledge.connections.connect","knowledge.connections.disconnect","knowledge.connections.request","knowledge.policies.coverage","knowledge.sources.get","knowledge.sources.history","knowledge.sources.list","knowledge.sources.search","knowledge.sources.archive","knowledge.sources.changeAudience","knowledge.sources.importConnected","knowledge.sources.importWebsite","knowledge.sources.publish","knowledge.sources.refresh","knowledge.sources.restore","knowledge.sources.save","knowledge.sources.withdraw","knowledge.sources.write","knowledge.uploads.get","knowledge.uploads.appendPart","knowledge.uploads.complete","knowledge.uploads.create","knowledge.uploads.retry","manager.current","mcp.knowledge","network.mine","network.ofPerson","network.orgChart","network.claim","notifications.preferences","notifications.save","onboarding.buddySuggestions","onboarding.candidates","onboarding.enrollmentPreview","onboarding.firstDaysCheckIns","onboarding.firstDaysResults","onboarding.mine","onboarding.person","onboarding.program","onboarding.answerBuddyAsk","onboarding.answerCheckIn","onboarding.answerFirstDaysCheckIn","onboarding.approve","onboarding.askBuddy","onboarding.assignBuddy","onboarding.enroll","onboarding.previewEnrollment","onboarding.remove","onboarding.respondBuddy","onboarding.retry","onboarding.saveProgram","onboarding.update","operations.activity","operations.status","operations.dispatchInbox","operations.reconcile","permissions.list","praise.composer","praise.feed","praise.insights","praise.mine","praise.ofPerson","praise.settings","praise.addChannel","praise.removeChannel","praise.saveSettings","praise.send","praise.setDigest","praise.setHidden","profiles.get","profiles.whoKnows","profiles.draft","profiles.employeeNumber","profiles.save","profiles.settings","profiles.cover.delete","profiles.photo.delete","profiles.positions.delete","profiles.positions.save","programs.get","programs.list","programs.options","programs.people","programs.preview","programs.schedulePreview","programs.archive","programs.create","programs.joinChannel","programs.pause","programs.resume","programs.syncRoster","programs.update","pulse.actions","pulse.asked","pulse.audienceOptions","pulse.insights","pulse.latestRead","pulse.mine","pulse.program","pulse.proposals","pulse.questionDetail","pulse.questions","pulse.today","pulse.addQuestion","pulse.addTemplate","pulse.answer","pulse.createAction","pulse.decideProposal","pulse.editProposal","pulse.proposeQuestions","pulse.requestProposals","pulse.saveProgram","pulse.setQuestionAudience","pulse.setQuestionStatus","pulse.skip","pulse.updateAction","reminders.mine","reminders.settings","reminders.saveMine","reminders.saveSetting","reports.answerFeedback","reports.connections","reports.knowledge","reports.knowledgeSource","reports.melloTrial","reports.melloValue","reports.needsYou","reports.onboarding","reports.overview","reports.people","runs.details","runs.get","runs.list","runs.dispatch","runs.request","runs.retry","runs.stopKnownFailures","runs.history.get","runs.history.list","support.get","support.list","support.assign","support.close","support.create","support.reply","sync.current","sync.connect","sync.disconnect","sync.request","sync.run","team.launchPost","team.answerMinutes","team.dismissLaunchPost","teams.connectionPermissions","teams.current","teams.setup","teams.slackChannels","teams.slackJoinAccess","teams.slackProfileLink","teams.discardPairHistory","teams.initialize","teams.moveSlackChannels","teams.rename","teams.resendSlackWelcome","teams.saveAgentSetup","teams.saveSlackJoinAccess","teams.saveSlackProfileLink","teams.status","teams.syncSlackProfileLinks","teams.uploadPairHistory","timeOff.balances","units.list","units.archive","units.save","users.activity","users.blockedPairs","users.details","users.filterOptions","users.get","users.list","users.managerHistory","users.managers","users.page","users.participants","users.reportingLineProposal","users.assignManagers","users.blockPair","users.participation","users.profile","users.proposeReportingLines","users.reviewReportingLines","users.save"],"type":"string"}}},"required":["catalog","permissions"]}}}},"400":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"BAD_REQUEST"},"status":{"const":400},"message":{"type":"string","default":"Check the request input."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"401":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"UNAUTHORIZED"},"status":{"const":401},"message":{"type":"string","default":"A valid Shuffl API token is required."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"403":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"FORBIDDEN"},"status":{"const":403},"message":{"type":"string","default":"This token or team role does not permit the operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"404":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"NOT_FOUND"},"status":{"const":404},"message":{"type":"string","default":"The requested resource was not found."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"409":{"description":"409","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"CONFLICT"},"status":{"const":409},"message":{"type":"string","default":"The resource changed or the request key was reused."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"412":{"description":"412","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"PRECONDITION_FAILED"},"status":{"const":412},"message":{"type":"string","default":"The team is not ready for this operation."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}},"429":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"defined":{"const":true},"code":{"const":"TOO_MANY_REQUESTS"},"status":{"const":429},"message":{"type":"string","default":"Too many requests. Try again shortly."},"data":{}},"required":["defined","code","status","message"]},{"type":"object","properties":{"defined":{"const":false},"code":{"type":"string"},"status":{"type":"number"},"message":{"type":"string"},"data":{}},"required":["defined","code","status","message"]}]}}}}},"x-shuffl-access":"read","x-shuffl-permission":"permissions.list"}}}}