{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:kumpeapps/auth-appkey-post":{"post":{"operationId":"open_data_kumpeapps_auth_appkey_post","summary":"Request app key","description":"POST /authentication/appkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","password","supportsYubikey"],"properties":{"username":{"type":"string","description":"Username assigned to your app"},"password":{"type":"string","description":"Password assigned to your app"},"supportsYubikey":{"type":"boolean","description":"App supports YubiKey OTP"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-appkey-put":{"post":{"operationId":"open_data_kumpeapps_auth_appkey_put","summary":"Deactivate app key","description":"PUT /authentication/appkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["app_key"],"properties":{"app_key":{"type":"string","description":"app key to deactivate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-appkey-patch":{"post":{"operationId":"open_data_kumpeapps_auth_appkey_patch","summary":"Compromise app key","description":"PATCH /authentication/appkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["app_key"],"properties":{"app_key":{"type":"string","description":"compromised app key"},"comments":{"type":"string","description":"Comments (like how was this compromised)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-authkey-get":{"get":{"operationId":"open_data_kumpeapps_auth_authkey_get","summary":"Request auth key for user (login user)","description":"GET /authentication/authkey","tags":["open-data"],"parameters":[{"name":"username","in":"query","required":true,"description":"Authenticated username","schema":{"type":"string","description":"Authenticated username"}},{"name":"password","in":"query","required":true,"description":"Authenticated password","schema":{"type":"string","description":"Authenticated password"}},{"name":"otp","in":"query","required":false,"description":"YubiKey OTP (if configured for user)","schema":{"type":"string","description":"YubiKey OTP (if configured for user)"}},{"name":"deviceName","in":"query","required":false,"description":"User's device name","schema":{"type":"string","description":"User's device name"}},{"name":"identifierForVendor","in":"query","required":false,"description":"identifierForVendor for User's Device (if app is iOS)","schema":{"type":"string","description":"identifierForVendor for User's Device (if app is iOS)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-authkey-post":{"post":{"operationId":"open_data_kumpeapps_auth_authkey_post","summary":"Request auth key for user (login user)","description":"POST /authentication/authkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","description":"Authenticated username"},"password":{"type":"string","description":"Authenticated password"},"otp":{"type":"string","description":"YubiKey OTP (if configured for user)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-authkey-put":{"post":{"operationId":"open_data_kumpeapps_auth_authkey_put","summary":"Deactivate auth key (logout)","description":"PUT /authentication/authkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["auth_key"],"properties":{"auth_key":{"type":"string","description":"auth key to logout"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-authkey-patch":{"post":{"operationId":"open_data_kumpeapps_auth_authkey_patch","summary":"Compromise auth key","description":"PATCH /authentication/authkey","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["auth_key"],"properties":{"auth_key":{"type":"string","description":"auth key to mark as compromised"},"comments":{"type":"string","description":"Comments (like how was this compromised)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/auth-verifyotp-get":{"get":{"operationId":"open_data_kumpeapps_auth_verifyotp_get","summary":"Verifies YubiKey OTP for authenticated user","description":"GET /authentication/verifyotp","tags":["open-data"],"parameters":[{"name":"otp","in":"query","required":true,"description":"YubiKey OTP code","schema":{"type":"string","description":"YubiKey OTP code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-allowance-get":{"get":{"operationId":"open_data_kumpeapps_kkid_allowance_get","summary":"returns allowance balance and allowance transactions","description":"GET /kkid/allowance","tags":["open-data"],"parameters":[{"name":"kidUserId","in":"query","required":true,"description":"userID of the kid","schema":{"type":"integer","description":"userID of the kid"}},{"name":"transactionDays","in":"query","required":false,"description":"number of days you wish to search allowance transactions (default is 90 days)","schema":{"type":"integer","description":"number of days you wish to search allowance transactions (default is 90 days)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-allowance-post":{"post":{"operationId":"open_data_kumpeapps_kkid_allowance_post","summary":"adds new allowance transaction to kidUserID","description":"POST /kkid/allowance","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["kidUserId","amount","description","transactionType"],"properties":{"kidUserId":{"type":"integer","description":"userID of the kid"},"amount":{"type":"number","description":"amount you wish to Add/Subtract (subtract value should be a negative value)"},"description":{"type":"string","description":"Description (reason) of allowance transaction"},"transactionType":{"type":"string","enum":["Add","Subtract"],"description":"Transaction Type (Add/Subtract)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-apns-post":{"post":{"operationId":"open_data_kumpeapps_kkid_apns_post","summary":"subscribes/unsubscribes/registers for apns push notifications","description":"POST /kkid/apns","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["kidUserId","tool"],"properties":{"kidUserId":{"type":"integer","description":"userID of the kid"},"tool":{"type":"string","enum":["register","subscribe","unsubscribe","send"],"description":"tool you wish to talk to"},"token":{"type":"string","description":"device APNS token (required for register)"},"devicename":{"type":"string","description":"Name of device to associate to token (required for register)"},"title":{"type":"string","description":"title of APNS message (required for send)"},"message":{"type":"string","description":"APNS message body (required for send)"},"badge":{"type":"integer","description":"Number for badge icon (optional for send)"},"sound":{"type":"string","description":"Name of sound file to play for send notification (optional for send)"},"section":{"type":"string","enum":["Chores","Chores-New","Chores-Reminders","Allowance","Allowance-New","WishList"],"description":"Notification section name (required for send/subscribe/unsubscribe)"},"priority":{"type":"string","enum":["passive","active","time-sensitive","critical"],"description":"Notification section name (optional for send, default is active)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-chorelist-get":{"get":{"operationId":"open_data_kumpeapps_kkid_chorelist_get","summary":"returns list of chores for given user","description":"GET /kkid/chorelist","tags":["open-data"],"parameters":[{"name":"kidUsername","in":"query","required":false,"description":"Username of kid you wish to search","schema":{"type":"string","description":"Username of kid you wish to search"}},{"name":"day","in":"query","required":false,"description":"Day of week for chores (Weekly for weekly chores)","schema":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Weekly"],"description":"Day of week for chores (Weekly for weekly chores)"}},{"name":"status","in":"query","required":false,"description":"Status of Chore to search","schema":{"type":"string","description":"Status of Chore to search"}},{"name":"blockDash","in":"query","required":false,"description":"Filter results by blockDash parameter","schema":{"type":"boolean","description":"Filter results by blockDash parameter"}},{"name":"optional","in":"query","required":false,"description":"Filter results by optional parameter","schema":{"type":"boolean","description":"Filter results by optional parameter"}},{"name":"canSteal","in":"query","required":false,"description":"Filter results by canSteal parameter","schema":{"type":"boolean","description":"Filter results by canSteal parameter"}},{"name":"includeCalendar","in":"query","required":false,"description":"include calendar notations (default is false)","schema":{"type":"boolean","description":"include calendar notations (default is false)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-chorelist-post":{"post":{"operationId":"open_data_kumpeapps_kkid_chorelist_post","summary":"adds chore for given user","description":"POST /kkid/chorelist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["kidUsername","choreName"],"properties":{"kidUsername":{"type":"string","description":"username of kid to assign the chore to."},"day":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Weekly","Today"],"description":"day of week (Monday, Tuesday....) for the chore. For weekly chores put Weekly or leave blank"},"nfcTag":{"type":"string","description":"text field of nfc tag required to check off chore"},"status":{"type":"string","description":"status of chore (default is todo)"},"choreName":{"type":"string","description":"name of chore"},"choreDescription":{"type":"string","description":"optional chore description"},"choreNumber":{"type":"integer","description":"number priority of chore (default is 5)"},"blockDash":{"type":"boolean","description":"block dash option on this chore"},"oneTime":{"type":"boolean","description":"mark as one time chore (does not repeat each week)"},"extraAllowance":{"type":"integer","description":"ammount of allowance added at end of week for completing this chore"},"optional":{"type":"boolean","description":"mark as optional chore"},"reassignable":{"type":"boolean","description":"mark as reassignable (default is true)"},"canSteal":{"type":"boolean","description":"mark as sibling can steal chore"},"startDate":{"type":"string","description":"date (yyyy-mm-dd) that you wish the chore to start showing up. (default is today)"},"notes":{"type":"string","description":"notes added to chore (visable only on reports, kids do not see this note, this is mostly just for the developer)"},"requireObjectDetection":{"type":"boolean","description":"require use of camera to detect object detection tag order to check off chore"},"objectDetectionTag":{"type":"string","description":"tag for object detection to search for (required if requireObjectDetection is true)"},"updatedByAutomation":{"type":"boolean","description":"true if chore updated via API from an Automation System"},"aiIcon":{"type":"string","description":"Notes if AI Icons should be used (n for no, y for yes, e for yes- error)"},"isCalendar":{"type":"boolean","description":"True if this is a calendar note instead of a chore."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-chorelist-put":{"post":{"operationId":"open_data_kumpeapps_kkid_chorelist_put","summary":"updates chore for given chore id","description":"PUT /kkid/chorelist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idChoreList"],"properties":{"idChoreList":{"type":"integer","description":"id number of chore you wish to update"},"status":{"type":"string","description":"new status of chore"},"stolen":{"type":"boolean","description":"mark chore as stolen by sibling"},"stolenBy":{"type":"string","description":"username of sibling that stole the chore (required if stolen is true)"},"nfcTag":{"type":"string","description":"text field of NFC tag that is required to be scanned to check off this chore (normally null)"},"notes":{"type":"string","description":"notes field for chore"},"latitude":{"type":"integer","description":"GPS latitude of where the chore was marked"},"longitude":{"type":"integer","description":"GPS longitude of where the chore was marked"},"altitude":{"type":"integer","description":"GPS altitude of where the chore was marked"},"updatedByAutomation":{"type":"boolean","description":"true if updated via API by automation system"},"whereDay":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Weekly","Today"],"description":"Where day equals..."},"whereStatus":{"type":"string","description":"Where status equals..."},"whereName":{"type":"string","description":"Where chore name equals..."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-chorelist-delete":{"post":{"operationId":"open_data_kumpeapps_kkid_chorelist_delete","summary":"deletes chore for given chore id","description":"DELETE /kkid/chorelist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["idChoreList"],"properties":{"idChoreList":{"type":"integer","description":"id of the chore you wish to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-masteruser-post":{"post":{"operationId":"open_data_kumpeapps_kkid_masteruser_post","summary":"adds new master user account","description":"POST /kkid/masteruser","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","password","email","firstName","lastName"],"properties":{"username":{"type":"string","description":"username of user to create"},"password":{"type":"string","description":"password of user to create"},"email":{"type":"string","description":"email address of user to create"},"firstName":{"type":"string","description":"First Name of user to create"},"lastName":{"type":"string","description":"Last Name of user to create"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-share-get":{"get":{"operationId":"open_data_kumpeapps_kkid_share_get","summary":"Create Share Link","description":"GET /kkid/share","tags":["open-data"],"parameters":[{"name":"linkUserId","in":"query","required":true,"description":"User ID that the link should be authenticated to","schema":{"type":"string","description":"User ID that the link should be authenticated to"}},{"name":"link","in":"query","required":true,"description":"Link to share","schema":{"type":"string","enum":["https://khome.kumpeapps.com/portal/wish-list.php","https://khome.kumpeapps.com/portal/chores-today.php"],"description":"Link to share"}},{"name":"scope","in":"query","required":true,"description":"Authentication scope for link","schema":{"type":"string","enum":["WishList","WishListAdmin","Chores","ChoresAdmin"],"description":"Authentication scope for link"}},{"name":"scope2","in":"query","required":false,"description":"Authentication scope for link","schema":{"type":"string","enum":["WishList","WishListAdmin","Chores","ChoresAdmin"],"description":"Authentication scope for link"}},{"name":"scope3","in":"query","required":false,"description":"Authentication scope for link","schema":{"type":"string","enum":["WishList","WishListAdmin","Chores","ChoresAdmin"],"description":"Authentication scope for link"}},{"name":"scope4","in":"query","required":false,"description":"Authentication scope for link","schema":{"type":"string","enum":["WishList","WishListAdmin","Chores","ChoresAdmin"],"description":"Authentication scope for link"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-user-get":{"get":{"operationId":"open_data_kumpeapps_kkid_user_get","summary":"Gets user info","description":"GET /kkid/user","tags":["open-data"],"parameters":[{"name":"enableBool","in":"query","required":false,"description":"Use bool values instead of Int 0/1","schema":{"type":"boolean","description":"Use bool values instead of Int 0/1"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-userlist-get":{"get":{"operationId":"open_data_kumpeapps_kkid_userlist_get","summary":"returns list of users","description":"GET /kkid/userlist","tags":["open-data"],"parameters":[{"name":"isChild","in":"query","required":false,"description":"Filter Search by isChild flag","schema":{"type":"boolean","description":"Filter Search by isChild flag"}},{"name":"isActive","in":"query","required":false,"description":"Filter Search by isActive flag","schema":{"type":"boolean","description":"Filter Search by isActive flag"}},{"name":"isAdmin","in":"query","required":false,"description":"Filter Search by isAdmin flag","schema":{"type":"boolean","description":"Filter Search by isAdmin flag"}},{"name":"enableAllowance","in":"query","required":false,"description":"Filter Search by enableAllowance flag","schema":{"type":"boolean","description":"Filter Search by enableAllowance flag"}},{"name":"enableChores","in":"query","required":false,"description":"Filter Search by enableChores flag","schema":{"type":"boolean","description":"Filter Search by enableChores flag"}},{"name":"userID","in":"query","required":false,"description":"userID of user to search","schema":{"type":"integer","description":"userID of user to search"}},{"name":"username","in":"query","required":false,"description":"Username of user to search","schema":{"type":"string","description":"Username of user to search"}},{"name":"email","in":"query","required":false,"description":"Email address of user to search","schema":{"type":"string","description":"Email address of user to search"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-userlist-post":{"post":{"operationId":"open_data_kumpeapps_kkid_userlist_post","summary":"adds new child user","description":"POST /kkid/userlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["username","password","email","firstName","lastName"],"properties":{"username":{"type":"string","description":"username of user to create"},"password":{"type":"string","description":"password of user to create"},"email":{"type":"string","description":"email address of user to create"},"firstName":{"type":"string","description":"First Name of user to create"},"lastName":{"type":"string","description":"Last Name of user to create"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-userlist-put":{"post":{"operationId":"open_data_kumpeapps_kkid_userlist_put","summary":"updates user","description":"PUT /kkid/userlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userID","username","email","firstName","lastName"],"properties":{"userID":{"type":"integer","description":"userID of the user you wish to update"},"username":{"type":"string","description":"username of user to create"},"email":{"type":"string","description":"email address of user to create"},"firstName":{"type":"string","description":"First Name of user to create"},"lastName":{"type":"string","description":"Last Name of user to create"},"emoji":{"type":"string","description":"emoji character for user"},"tmdbKey":{"type":"string","description":"User's TMdB Session Key"},"enableWishList":{"type":"boolean","description":"set status of Wish List module enabled"},"enableChores":{"type":"boolean","description":"set status of chores module enabled"},"enableAllowance":{"type":"boolean","description":"set status of allowance module enabled"},"enableAdmin":{"type":"boolean","description":"set status of isAdmin"},"enableTmdb":{"type":"boolean","description":"set status of enableTmdb (movie and tv search)"},"enableObjectDetection":{"type":"boolean","description":"set status of enableObjectDetection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-userlist-delete":{"post":{"operationId":"open_data_kumpeapps_kkid_userlist_delete","summary":"deletes user","description":"DELETE /kkid/userlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userID"],"properties":{"userID":{"type":"integer","description":"userID of the user you wish to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-wishlist-get":{"get":{"operationId":"open_data_kumpeapps_kkid_wishlist_get","summary":"Get list of wishlist items","description":"GET /kkid/wishlist","tags":["open-data"],"parameters":[{"name":"kidUserId","in":"query","required":false,"description":"userID of the kid","schema":{"type":"integer","description":"userID of the kid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-wishlist-post":{"post":{"operationId":"open_data_kumpeapps_kkid_wishlist_post","summary":"Add item to kid's wishlist","description":"POST /kkid/wishlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["kidUserId","title"],"properties":{"kidUserId":{"type":"integer","description":"userID of the kid"},"title":{"type":"string","description":"Item title"},"description":{"type":"string","description":"Item Description"},"priority":{"type":"integer","description":"Item Priority"},"link":{"type":"string","description":"URL Link to item"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-wishlist-put":{"post":{"operationId":"open_data_kumpeapps_kkid_wishlist_put","summary":"Update item on kid's wishlist","description":"PUT /kkid/wishlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["wishId"],"properties":{"wishId":{"type":"integer","description":"Wish list item ID to update"},"title":{"type":"string","description":"Item title"},"description":{"type":"string","description":"Item Description"},"priority":{"type":"integer","description":"Item Priority"},"link":{"type":"string","description":"URL Link to item"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:kumpeapps/kkid-wishlist-delete":{"post":{"operationId":"open_data_kumpeapps_kkid_wishlist_delete","summary":"Delete item from wishlist","description":"DELETE /kkid/wishlist","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["wishId"],"properties":{"wishId":{"type":"integer","description":"ID of wishlist item to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}