diff --git a/enterprise/next/api/AppExpireJob.html b/enterprise/next/api/AppExpireJob.html index b813658b361..4d59a731486 100644 --- a/enterprise/next/api/AppExpireJob.html +++ b/enterprise/next/api/AppExpireJob.html @@ -347,7 +347,7 @@
|$)/g,Ae=>Ae.replace(/([^>\r\n]?)(\r\n|\n\r|\r|\n)/g,"$1
$2"))}p().registerHelper("each_compare_list_field",function(Y,Ae,ge){const me=ge.hash.field,Ce=[];Y&&Y.forEach(function(Ue){const ze=Ue;ze.key=Ue[me],Ce.push(ze)});const $e=[];return Ae&&Ae.forEach(function(Ue){const ze=Ue;ze.key=Ue[me],$e.push(ze)}),we("key",Ce,$e,ge)}),p().registerHelper("each_compare_keys",function(Y,Ae,ge){const me=[];Y&&Object.keys(Y).forEach(function(Ue){const ze={};ze.value=Y[Ue],ze.key=Ue,me.push(ze)});const Ce=[];return Ae&&Object.keys(Ae).forEach(function(Ue){const ze={};ze.value=Ae[Ue],ze.key=Ue,Ce.push(ze)}),we("key",me,Ce,ge)}),p().registerHelper("body2json",function(Y,Ae){return xe(Y)}),p().registerHelper("each_compare_field",function(Y,Ae,ge){return we("field",Y,Ae,ge)}),p().registerHelper("each_compare_title",function(Y,Ae,ge){return we("title",Y,Ae,ge)}),p().registerHelper("reformat",function(Y,Ae){if(Ae==="json")try{return JSON.stringify(JSON.parse(Y.trim()),null," ")}catch(ge){}return Y}),p().registerHelper("showDiff",function(Y,Ae,ge){let me="";if(Y===Ae)me=Y;else{if(!Y)return Ae;if(!Ae)return Y;const Ce=new ke;if(ge==="code"){const $e=Ce.diffLineMode(Ae,Y);me=Ce.diffPrettyCode($e)}else{const $e=Ce.diffMain(Ae,Y);Ce.diffCleanupSemantic($e),me=Ce.diffPrettyHtml($e),me=me.replace(/¶/gm,""),ge==="nl2br"&&(me=De(me))}}return me});function we(Y,Ae,ge,me){const Ce=[];let $e=0;Ae&&Ae.forEach(function(et){let pt=!1;if(ge&&ge.forEach(function(yt){if(et[Y]===yt[Y]){const qt={typeSame:!0,source:et,compare:yt,index:$e};Ce.push(qt),pt=!0,$e++}}),!pt){const yt={typeIns:!0,source:et,index:$e};Ce.push(yt),$e++}}),ge&&ge.forEach(function(et){let pt=!1;if(Ae&&Ae.forEach(function(yt){yt[Y]===et[Y]&&(pt=!0)}),!pt){const yt={typeDel:!0,compare:et,index:$e};Ce.push(yt),$e++}});let Ue="";const ze=Ce.length;for(const et in Ce)parseInt(et,10)===ze-1&&(Ce[et]._last=!0),Ue=Ue+me.fn(Ce[et]);return Ue}}document.addEventListener("DOMContentLoaded",()=>{Ut(),R(),h().highlightAll()});function Ut(){var We;let Ie=[{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"public",title:"",version:"0.0.0",filename:"core/frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/libs/express-expose.js",name:"Public"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"",version:"0.0.0",filename:"core/plugins/push/api/api-message.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/plugins/push/api/api-message.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/core/plugins/push/api/api-message.js",name:"",body:[{group:"Body",type:"ObjectID",optional:!1,field:"app",isArray:!1,description:"Application ID
"},{group:"Body",type:"Boolean",optional:!1,field:"saveStats",isArray:!1,description:"Store each individual push records into push_stats for debugging
",checked:!1},{group:"Body",type:"String[]",optional:!1,field:"platforms",isArray:!0,description:"Array of platforms to send to
"},{group:"Body",type:"String",allowedValues:['"draft"'],optional:!0,field:"status",isArray:!1,description:"Message status, only set to draft when creating or editing a draft message, don't set otherwise
"},{group:"Body",type:"Object",optional:!1,field:"filter",isArray:!1,defaultValue:"{}",description:"User profile filter to limit recipients of this message
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.user",isArray:!1,description:"JSON with app_usersAPPID collection filter
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.drill",isArray:!1,description:"Drill plugin filter in JSON format
"},{group:"Body",type:"ObjectID[]",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.geos",isArray:!0,description:"Array of geo IDs
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.cohorts",isArray:!0,description:"Array of cohort IDs
"},{group:"Body",type:"Object[]",optional:!1,field:"triggers",isArray:!0,description:"Array of triggers this message should be sent on
"},{group:"Body",type:"String",allowedValues:['"plain"','"event"','"cohort"','"api"'],optional:!1,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.kind",isArray:!1,description:"Trigger kind: "plain" (send on date), "event" (when user performs event), "cohort" (on cohort entry or exit), "api" (on /push API call)
"},{group:"Body",type:"Date",optional:!1,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.start",isArray:!1,description:"Campaign start date (epoch or ISO date string)
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.sctz",isArray:!1,description:"[only for plain trigger] Send in users' timezones switch, a number representing message creator offset timezone in minutes (GMT+3 is -180)
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.delayed",isArray:!1,description:"[only for plain trigger] Delay audience selection to 5 minutes prior to start date
",checked:!1},{group:"Body",type:"Date",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.end",isArray:!1,description:"[only for event, cohort & api triggers] Campaign end date (epoch or ISO date string)
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.actuals",isArray:!1,description:"[only for event, cohort triggers] Use event / cohort date instead of date of event arrival to the server date / cohort recalculation date
",checked:!1},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.time",isArray:!1,description:"[only for event, cohort triggers] Time in ms since 00:00 in case event or cohort message is to be sent in users' timezones
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.reschedule",isArray:!1,description:"[only for event, cohort triggers] Allow rescheduling to next day if it's too late to send on scheduled day
",checked:!1},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.delay",isArray:!1,description:"[only for event, cohort triggers] Milliseconds to delay sending of event or cohort message
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cap",isArray:!1,description:"[only for event, cohort & api triggers] Set maximum number of notifications sent to a particular user
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.sleep",isArray:!1,description:"[only for event, cohort & api triggers] Set minimum time in ms between two notifications for a particular user (a notification is discarded if it's less than that)
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.events",isArray:!0,description:"[only for event trigger] Event keys
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cohorts",isArray:!0,description:"[only for cohort trigger] Cohort ids
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.entry",isArray:!1,description:"[only for cohort trigger] Send on cohort entry (true) or exit (false)
",checked:!1},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cancels",isArray:!1,description:"[only for cohort trigger] A notification is to be discarded if user exits cohort (when entry = true) before notification is sent
",checked:!1},{group:"Body",type:"Object[]",optional:!1,field:"contents",isArray:!0,description:"Array of contents objects. One content object without "p" & "la" keys is required to be first in the array. Every following content object (index 1 or more) can be with or without p/la keys and override properties set previously.
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.p",isArray:!1,description:"Platform this content object applies to
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.la",isArray:!1,description:"Language this content is for (2-letter ISO language key)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.message",isArray:!1,description:"Notification message string
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.messagePers",isArray:!1,description:"Notification message personalisation object - a map of indexes within message string to an object with keys: "k" (user property key or event data key), "c" (capitalize custom property value), "f" (fallback value), "t" (type of personalization object, can be one of: "e" for event, "u" for user property, "c" for custom user property, "a" for API variable)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.title",isArray:!1,description:"Notification title string
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.titlePers",isArray:!1,description:"Notification title personalisation object (see contents.messagePers for explanation)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.sound",isArray:!1,description:"Notification sound
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.badge",isArray:!1,description:"Notification badge
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.data",isArray:!1,description:"Notification data in JSON format
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.extras",isArray:!0,description:"Array of extras keys - user profile property keys to send along with notification
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.url",isArray:!1,description:"Notification on-tap URL
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.media",isArray:!1,description:"Notification media attachment URL
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.mediaMime",isArray:!1,description:"Notification media MIME type
"},{group:"Body",type:"Object[]",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",isArray:!0,description:"Button object array
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.title",isArray:!1,description:"Button title
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.pers",isArray:!1,description:"Button title personalization object (see contents.messagePers for explanation)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.url",isArray:!1,description:"Button URL
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.specific",isArray:!1,description:"Platform-specific content map, currently supported keys are "subtitle" for iOS & "large_icon" for Android
"}]},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",name:"Private"},{type:"",url:"public",title:"",version:"0.0.0",filename:"frontend/express/libs/express-expose.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/libs/express-expose.js",name:"Public"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"private",title:"",version:"0.0.0",filename:"frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/frontend/express/public/javascripts/visualization/flot/jquery.flot.spline.js",name:"Private"},{type:"",url:"",version:"0.0.0",filename:"plugins/push/api/api-message.js",groupTitle:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/plugins/push/api/api-message.js",group:"/home/runner/work/countly-enterprise-plugins/countly-enterprise-plugins/code_docs/repo/plugins/push/api/api-message.js",name:"",body:[{group:"Body",type:"ObjectID",optional:!1,field:"app",isArray:!1,description:"Application ID
"},{group:"Body",type:"Boolean",optional:!1,field:"saveStats",isArray:!1,description:"Store each individual push records into push_stats for debugging
",checked:!1},{group:"Body",type:"String[]",optional:!1,field:"platforms",isArray:!0,description:"Array of platforms to send to
"},{group:"Body",type:"String",allowedValues:['"draft"'],optional:!0,field:"status",isArray:!1,description:"Message status, only set to draft when creating or editing a draft message, don't set otherwise
"},{group:"Body",type:"Object",optional:!1,field:"filter",isArray:!1,defaultValue:"{}",description:"User profile filter to limit recipients of this message
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.user",isArray:!1,description:"JSON with app_usersAPPID collection filter
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.drill",isArray:!1,description:"Drill plugin filter in JSON format
"},{group:"Body",type:"ObjectID[]",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.geos",isArray:!0,description:"Array of geo IDs
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"filter",field:"filter",type:"Object",isArray:!1},field:"filter.cohorts",isArray:!0,description:"Array of cohort IDs
"},{group:"Body",type:"Object[]",optional:!1,field:"triggers",isArray:!0,description:"Array of triggers this message should be sent on
"},{group:"Body",type:"String",allowedValues:['"plain"','"event"','"cohort"','"api"'],optional:!1,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.kind",isArray:!1,description:"Trigger kind: "plain" (send on date), "event" (when user performs event), "cohort" (on cohort entry or exit), "api" (on /push API call)
"},{group:"Body",type:"Date",optional:!1,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.start",isArray:!1,description:"Campaign start date (epoch or ISO date string)
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.sctz",isArray:!1,description:"[only for plain trigger] Send in users' timezones switch, a number representing message creator offset timezone in minutes (GMT+3 is -180)
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.delayed",isArray:!1,description:"[only for plain trigger] Delay audience selection to 5 minutes prior to start date
",checked:!1},{group:"Body",type:"Date",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.end",isArray:!1,description:"[only for event, cohort & api triggers] Campaign end date (epoch or ISO date string)
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.actuals",isArray:!1,description:"[only for event, cohort triggers] Use event / cohort date instead of date of event arrival to the server date / cohort recalculation date
",checked:!1},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.time",isArray:!1,description:"[only for event, cohort triggers] Time in ms since 00:00 in case event or cohort message is to be sent in users' timezones
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.reschedule",isArray:!1,description:"[only for event, cohort triggers] Allow rescheduling to next day if it's too late to send on scheduled day
",checked:!1},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.delay",isArray:!1,description:"[only for event, cohort triggers] Milliseconds to delay sending of event or cohort message
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cap",isArray:!1,description:"[only for event, cohort & api triggers] Set maximum number of notifications sent to a particular user
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.sleep",isArray:!1,description:"[only for event, cohort & api triggers] Set minimum time in ms between two notifications for a particular user (a notification is discarded if it's less than that)
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.events",isArray:!0,description:"[only for event trigger] Event keys
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cohorts",isArray:!0,description:"[only for cohort trigger] Cohort ids
"},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.entry",isArray:!1,description:"[only for cohort trigger] Send on cohort entry (true) or exit (false)
",checked:!1},{group:"Body",type:"Boolean",optional:!0,parentNode:{path:"triggers",field:"triggers",type:"Object[]",isArray:!0},field:"triggers.cancels",isArray:!1,description:"[only for cohort trigger] A notification is to be discarded if user exits cohort (when entry = true) before notification is sent
",checked:!1},{group:"Body",type:"Object[]",optional:!1,field:"contents",isArray:!0,description:"Array of contents objects. One content object without "p" & "la" keys is required to be first in the array. Every following content object (index 1 or more) can be with or without p/la keys and override properties set previously.
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.p",isArray:!1,description:"Platform this content object applies to
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.la",isArray:!1,description:"Language this content is for (2-letter ISO language key)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.message",isArray:!1,description:"Notification message string
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.messagePers",isArray:!1,description:"Notification message personalisation object - a map of indexes within message string to an object with keys: "k" (user property key or event data key), "c" (capitalize custom property value), "f" (fallback value), "t" (type of personalization object, can be one of: "e" for event, "u" for user property, "c" for custom user property, "a" for API variable)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.title",isArray:!1,description:"Notification title string
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.titlePers",isArray:!1,description:"Notification title personalisation object (see contents.messagePers for explanation)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.sound",isArray:!1,description:"Notification sound
"},{group:"Body",type:"Number",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.badge",isArray:!1,description:"Notification badge
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.data",isArray:!1,description:"Notification data in JSON format
"},{group:"Body",type:"String[]",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.extras",isArray:!0,description:"Array of extras keys - user profile property keys to send along with notification
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.url",isArray:!1,description:"Notification on-tap URL
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.media",isArray:!1,description:"Notification media attachment URL
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.mediaMime",isArray:!1,description:"Notification media MIME type
"},{group:"Body",type:"Object[]",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",isArray:!0,description:"Button object array
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.title",isArray:!1,description:"Button title
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.pers",isArray:!1,description:"Button title personalization object (see contents.messagePers for explanation)
"},{group:"Body",type:"String",optional:!0,parentNode:{path:"contents.buttons",parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.buttons",type:"Object[]",isArray:!0},field:"contents.buttons.url",isArray:!1,description:"Button URL
"},{group:"Body",type:"Object",optional:!0,parentNode:{path:"contents",field:"contents",type:"Object[]",isArray:!0},field:"contents.specific",isArray:!1,description:"Platform-specific content map, currently supported keys are "subtitle" for iOS & "large_icon" for Android
"}]},{type:"get",url:"/i/ab-testing/add-experiment",title:"Create an experiment",name:"AddABTestingExperiment",group:"AB_Testing",permission:[{name:"user"}],description:"Add a new AB test experiment.
",query:[{group:"Query",type:"String",optional:!1,field:"app_id",isArray:!1,description:"Application ID
"},{group:"Query",type:"String",optional:!1,field:"experiment",isArray:!1,description:"Experiment information
"}],success:{fields:{"Success 200":[{group:"Success 200",type:"String",optional:!1,field:"experiment_id",isArray:!1,description:"Id of the experiment created
"}]}},version:"0.0.0",filename:"plugins/ab-testing/api/api.js",groupTitle:"AB_Testing"},{type:"get",url:"/o/ab-testing/check-models",title:"Check AB models",name:"CheckABModels",group:"AB_Testing",permission:[{name:"user"}],description:"Check if AB testing models are available
",success:{fields:{"Success 200":[{group:"Success 200",type:"String",optional:!1,field:"result",isArray:!1,description:"Result of the check
"}]},examples:[{title:"Success-Response:",content:`{ "result": "Success" @@ -3392,4 +3392,4 @@ true`,type:"text"}]},version:"0.0.0",filename:"plugins/reports/api/api.js",group "percentage": "0.00", "timeStamp": 1642644827 } - ]`,type:"json"}]},version:"0.0.0",filename:"plugins/slipping-away-users/api/api.js",groupTitle:"slipping"}];const de={name:"countly-apidoc",version:"23.11.0",description:"Countly Api Docs",title:"Countly Api Docs",url:"https://api.count.ly/",template:{withCompare:!0,withGenerator:!1},sampleUrl:!1,defaultVersion:"0.0.0",apidoc:"0.3.0",generator:{name:"apidoc",time:"Tue Dec 17 2024 19:02:14 GMT+0000 (Coordinated Universal Time)",url:"https://apidocjs.com",version:"1.2.0"}};gt();const De=p().compile(y()("#template-header").html()),we=p().compile(y()("#template-footer").html()),Y=p().compile(y()("#template-article").html()),Ae=p().compile(y()("#template-compare-article").html()),ge=p().compile(y()("#template-generator").html()),me=p().compile(y()("#template-project").html()),Ce=p().compile(y()("#template-sections").html()),$e=p().compile(y()("#template-sidenav").html()),Ue={aloneDisplay:!1,showRequiredLabels:!1,withGenerator:!0,withCompare:!0};de.template=Object.assign(Ue,(We=de.template)!=null?We:{}),de.template.forceLanguage&&vt(de.template.forceLanguage);const ze=(0,n.groupBy)(Ie,ne=>ne.group),et={};y().each(ze,(ne,ie)=>{et[ne]=(0,n.groupBy)(ie,le=>le.name)});const pt=[];y().each(et,(ne,ie)=>{let le=[];y().each(ie,(pe,Te)=>{const Le=Te[0].title;Le&&le.push(Le.toLowerCase()+"#~#"+pe)}),le.sort(),de.order&&(le=Pe(le,de.order,"#~#")),le.forEach(pe=>{const Le=pe.split("#~#")[1];ie[Le].forEach(Re=>{pt.push(Re)})})}),Ie=pt;let yt={};const qt={};let Bt={};Bt[de.version]=1,y().each(Ie,(ne,ie)=>{yt[ie.group]=1,qt[ie.group]=ie.groupTitle||ie.group,Bt[ie.version]=1}),yt=Object.keys(yt),yt.sort(),de.order&&(yt=Ne(qt,de.order)),Bt=Object.keys(Bt),Bt.sort(i().compare),Bt.reverse();const wt=[];yt.forEach(ne=>{wt.push({group:ne,isHeader:!0,title:qt[ne]});let ie="";Ie.forEach(le=>{le.group===ne&&(ie!==le.name?wt.push({title:le.title,group:ne,name:le.name,type:le.type,version:le.version,url:le.url}):wt.push({title:le.title,group:ne,hidden:!0,name:le.name,type:le.type,version:le.version,url:le.url}),ie=le.name)})});function cr(ne,ie,le){let pe=!1;if(!ie)return pe;const Te=ie.match(/(.+?)<\/h(1|2)>/gi);return Te&&Te.forEach(function(Le){const Re=Le.substring(2,3),lt=Le.replace(/<.+?>/g,""),_t=Le.match(/id="api-([^-]+)(?:-(.+))?"/),Dt=_t?_t[1]:null,ht=_t?_t[2]:null;Re==="1"&<&&Dt&&(ne.splice(le,0,{group:Dt,isHeader:!0,title:lt,isFixed:!0}),le++,pe=!0),Re==="2"&<&&Dt&&ht&&(ne.splice(le,0,{group:Dt,name:ht,isHeader:!1,title:lt,isFixed:!1,version:"1.0"}),le++)}),pe}let fr;if(de.header&&(fr=cr(wt,de.header.content,0),fr||wt.unshift({group:"_header",isHeader:!0,title:de.header.title==null?bt("General"):de.header.title,isFixed:!0})),de.footer){const ne=wt.length;fr=cr(wt,de.footer.content,wt.length),!fr&&de.footer.title!=null&&wt.splice(ne,0,{group:"_footer",isHeader:!0,title:de.footer.title,isFixed:!0})}const Or=de.title?de.title:"apiDoc: "+de.name+" - "+de.version;y()(document).attr("title",Or),y()("#loader").remove();const kr={nav:wt};y()("#sidenav").append($e(kr)),y()("#generator").append(ge(de)),(0,n.extend)(de,{versions:Bt}),y()("#project").append(me(de)),de.header&&y()("#header").append(De(de.header)),de.footer&&(y()("#footer").append(we(de.footer)),de.template.aloneDisplay&&document.getElementById("api-_footer").classList.add("hide"));const Mt={};let Cr="";yt.forEach(function(ne){const ie=[];let le="",pe={},Te=ne,Le="";Mt[ne]={},Ie.forEach(function(Re){ne===Re.group&&(le!==Re.name?(Ie.forEach(function(lt){ne===lt.group&&Re.name===lt.name&&(Object.prototype.hasOwnProperty.call(Mt[Re.group],Re.name)||(Mt[Re.group][Re.name]=[]),Mt[Re.group][Re.name].push(lt.version))}),pe={article:Re,versions:Mt[Re.group][Re.name]}):pe={article:Re,hidden:!0,versions:Mt[Re.group][Re.name]},de.sampleUrl&&de.sampleUrl===!0&&(de.sampleUrl=window.location.origin),de.url&&pe.article.url.substr(0,4).toLowerCase()!=="http"&&(pe.article.url=de.url+pe.article.url),oe(pe,Re),Re.groupTitle&&(Te=Re.groupTitle),Re.groupDescription&&(Le=Re.groupDescription),ie.push({article:Y(pe),group:Re.group,name:Re.name,aloneDisplay:de.template.aloneDisplay}),le=Re.name)}),pe={group:ne,title:Te,description:Le,articles:ie,aloneDisplay:de.template.aloneDisplay},Cr+=Ce(pe)}),y()("#sections").append(Cr),de.template.aloneDisplay||(document.body.dataset.spy="scroll",y()("body").scrollspy({target:"#scrollingNav"})),y()(".form-control").on("focus change",function(){y()(this).removeClass("border-danger")}),y()(".sidenav").find("a").on("click",function(ne){ne.preventDefault();const ie=this.getAttribute("href");if(de.template.aloneDisplay){const le=document.querySelector(".sidenav > li.active");le&&le.classList.remove("active"),this.parentNode.classList.add("active")}else{const le=document.querySelector(ie);le&&y()("html,body").animate({scrollTop:le.offsetTop},400)}window.location.hash=ie});function St(ne){let ie=!1;return y().each(ne,le=>{ie=ie||(0,n.some)(ne[le],pe=>pe.type)}),ie}function qr(){y()('button[data-toggle="popover"]').popover().click(function(ie){ie.preventDefault()});const ne=y()("#version strong").html();if(y()("#sidenav li").removeClass("is-new"),de.template.withCompare&&y()("#sidenav li[data-version='"+ne+"']").each(function(){const ie=y()(this).data("group"),le=y()(this).data("name"),pe=y()("#sidenav li[data-group='"+ie+"'][data-name='"+le+"']").length,Te=y()("#sidenav li[data-group='"+ie+"'][data-name='"+le+"']").index(y()(this));(pe===1||Te===pe-1)&&y()(this).addClass("is-new")}),y()(".nav-tabs-examples a").click(function(ie){ie.preventDefault(),y()(this).tab("show")}),y()(".nav-tabs-examples").find("a:first").tab("show"),y()(".sample-request-content-type-switch").change(function(){y()(this).val()==="body-form-data"?(y()("#sample-request-body-json-input-"+y()(this).data("id")).hide(),y()("#sample-request-body-form-input-"+y()(this).data("id")).show()):(y()("#sample-request-body-form-input-"+y()(this).data("id")).hide(),y()("#sample-request-body-json-input-"+y()(this).data("id")).show())}),de.template.aloneDisplay&&(y()(".show-group").click(function(){const ie="."+y()(this).attr("data-group")+"-group",le="."+y()(this).attr("data-group")+"-article";y()(".show-api-group").addClass("hide"),y()(ie).removeClass("hide"),y()(".show-api-article").addClass("hide"),y()(le).removeClass("hide")}),y()(".show-api").click(function(){const ie=this.getAttribute("href").substring(1),le=document.getElementById("version").textContent.trim(),pe=`.${this.dataset.name}-article`,Te=`[id="${ie}-${le}"]`,Le=`.${this.dataset.group}-group`;y()(".show-api-group").addClass("hide"),y()(Le).removeClass("hide"),y()(".show-api-article").addClass("hide");let Re=y()(pe);y()(Te).length&&(Re=y()(Te).parent()),Re.removeClass("hide"),ie.match(/_(header|footer)/)&&document.getElementById(ie).classList.remove("hide")})),de.template.aloneDisplay||y()("body").scrollspy("refresh"),de.template.aloneDisplay){const ie=decodeURI(window.location.hash);if(ie!=null&&ie.length!==0){const le=document.getElementById("version").textContent.trim(),pe=document.querySelector(`li .${ie.slice(1)}-init`),Te=document.querySelector(`li[data-version="${le}"] .show-api.${ie.slice(1)}-init`);let Le=pe;Te&&(Le=Te),Le.click()}}}function M(ne){typeof ne=="undefined"?ne=y()("#version strong").html():y()("#version strong").html(ne),y()("article").addClass("hide"),y()("#sidenav li:not(.nav-fixed)").addClass("hide");const ie={};document.querySelectorAll("article[data-version]").forEach(le=>{const pe=le.dataset.group,Te=le.dataset.name,Le=le.dataset.version,Re=pe+Te;!ie[Re]&&i().lte(Le,ne)&&(ie[Re]=!0,document.querySelector(`article[data-group="${pe}"][data-name="${Te}"][data-version="${Le}"]`).classList.remove("hide"),document.querySelector(`#sidenav li[data-group="${pe}"][data-name="${Te}"][data-version="${Le}"]`).classList.remove("hide"),document.querySelector(`#sidenav li.nav-header[data-group="${pe}"]`).classList.remove("hide"))}),y()("article[data-version]").each(function(le){const pe=y()(this).data("group");y()("section#api-"+pe).removeClass("hide"),y()("section#api-"+pe+" article:visible").length===0?y()("section#api-"+pe).addClass("hide"):y()("section#api-"+pe).removeClass("hide")})}if(M(),y()("#versions li.version a").on("click",function(ne){ne.preventDefault(),M(y()(this).html())}),y()("#compareAllWithPredecessor").on("click",ee),y()("article .versions li.version a").on("click",X),y().urlParam=function(ne){const ie=new RegExp("[\\?&]"+ne+"=([^&#]*)").exec(window.location.href);return ie&&ie[1]?ie[1]:null},y().urlParam("compare")&&y()("#compareAllWithPredecessor").trigger("click"),window.location.hash){const ne=decodeURI(window.location.hash);y()(ne).length>0&&y()("html,body").animate({scrollTop:parseInt(y()(ne).offset().top)},0)}document.querySelector('[data-toggle="offcanvas"]').addEventListener("click",function(){const ne=document.querySelector(".row-offcanvas");ne&&ne.classList.toggle("active")}),y()("#scrollingNav .sidenav-search input.search").focus(),y()('[data-action="filter-search"]').on("keyup",z(ne=>{const ie=ne.currentTarget.value.toLowerCase();y()(".sidenav a.nav-list-item").filter((le,pe)=>y()(pe).toggle(y()(pe).text().toLowerCase().indexOf(ie)>-1))},200)),y()("span.search-reset").on("click",function(){y()("#scrollingNav .sidenav-search input.search").val("").focus(),y()(".sidenav").find("a.nav-list-item").show()});function z(ne,ie){let le=null;return(...pe)=>{clearTimeout(le),le=setTimeout(ne.bind(this,...pe),ie||0)}}function X(ne){ne.preventDefault();const ie=y()(this).parents("article"),le=y()(this).html(),pe=ie.find(".version"),Te=pe.find("strong").html();pe.find("strong").html(le);const Le=ie.data("group"),Re=ie.data("name"),lt=ie.data("version"),_t=ie.data("compare-version");if(_t!==le&&!(!_t&<===le)){if(_t&&Mt[Le][Re][0]===le||lt===le)_e(Le,Re,lt);else{let Dt={},ht={};y().each(et[Le][Re],function(oi,Gr){Gr.version===lt&&(Dt=Gr),Gr.version===le&&(ht=Gr)});const ot={article:Dt,compare:ht,versions:Mt[Le][Re]};ot.article.id=ot.article.group+"-"+ot.article.name+"-"+ot.article.version,ot.article.id=ot.article.id.replace(/\./g,"_"),ot.compare.id=ot.compare.group+"-"+ot.compare.name+"-"+ot.compare.version,ot.compare.id=ot.compare.id.replace(/\./g,"_");let rt=Dt;rt.header&&rt.header.fields&&(ot._hasTypeInHeaderFields=St(rt.header.fields)),rt.parameter&&rt.parameter.fields&&(ot._hasTypeInParameterFields=St(rt.parameter.fields)),rt.error&&rt.error.fields&&(ot._hasTypeInErrorFields=St(rt.error.fields)),rt.success&&rt.success.fields&&(ot._hasTypeInSuccessFields=St(rt.success.fields)),rt.info&&rt.info.fields&&(ot._hasTypeInInfoFields=St(rt.info.fields)),rt=ht,ot._hasTypeInHeaderFields!==!0&&rt.header&&rt.header.fields&&(ot._hasTypeInHeaderFields=St(rt.header.fields)),ot._hasTypeInParameterFields!==!0&&rt.parameter&&rt.parameter.fields&&(ot._hasTypeInParameterFields=St(rt.parameter.fields)),ot._hasTypeInErrorFields!==!0&&rt.error&&rt.error.fields&&(ot._hasTypeInErrorFields=St(rt.error.fields)),ot._hasTypeInSuccessFields!==!0&&rt.success&&rt.success.fields&&(ot._hasTypeInSuccessFields=St(rt.success.fields)),ot._hasTypeInInfoFields!==!0&&rt.info&&rt.info.fields&&(ot._hasTypeInInfoFields=St(rt.info.fields));const fn=Ae(ot);ie.after(fn),ie.next().find(".versions li.version a").on("click",X),y()("#sidenav li[data-group='"+Le+"'][data-name='"+Re+"'][data-version='"+Te+"']").addClass("has-modifications"),ie.remove()}qr(),h().highlightAll()}}function ee(ne){ne.preventDefault(),y()("article:visible .versions").each(function(){const le=y()(this).parents("article").data("version");let pe=null;y()(this).find("li.version a").each(function(){y()(this).html() {Object.keys(ne).forEach(Te=>{ne[Te].replace(/_/g," ")===pe&&le.push(Te)})}),Object.keys(ne).forEach(pe=>{le.indexOf(pe)===-1&&le.push(pe)}),le}qr()}})()})(); + ]`,type:"json"}]},version:"0.0.0",filename:"plugins/slipping-away-users/api/api.js",groupTitle:"slipping"}];const de={name:"countly-apidoc",version:"23.11.0",description:"Countly Api Docs",title:"Countly Api Docs",url:"https://api.count.ly/",template:{withCompare:!0,withGenerator:!1},sampleUrl:!1,defaultVersion:"0.0.0",apidoc:"0.3.0",generator:{name:"apidoc",time:"Thu Dec 19 2024 08:55:41 GMT+0000 (Coordinated Universal Time)",url:"https://apidocjs.com",version:"1.2.0"}};gt();const De=p().compile(y()("#template-header").html()),we=p().compile(y()("#template-footer").html()),Y=p().compile(y()("#template-article").html()),Ae=p().compile(y()("#template-compare-article").html()),ge=p().compile(y()("#template-generator").html()),me=p().compile(y()("#template-project").html()),Ce=p().compile(y()("#template-sections").html()),$e=p().compile(y()("#template-sidenav").html()),Ue={aloneDisplay:!1,showRequiredLabels:!1,withGenerator:!0,withCompare:!0};de.template=Object.assign(Ue,(We=de.template)!=null?We:{}),de.template.forceLanguage&&vt(de.template.forceLanguage);const ze=(0,n.groupBy)(Ie,ne=>ne.group),et={};y().each(ze,(ne,ie)=>{et[ne]=(0,n.groupBy)(ie,le=>le.name)});const pt=[];y().each(et,(ne,ie)=>{let le=[];y().each(ie,(pe,Te)=>{const Le=Te[0].title;Le&&le.push(Le.toLowerCase()+"#~#"+pe)}),le.sort(),de.order&&(le=Pe(le,de.order,"#~#")),le.forEach(pe=>{const Le=pe.split("#~#")[1];ie[Le].forEach(Re=>{pt.push(Re)})})}),Ie=pt;let yt={};const qt={};let Bt={};Bt[de.version]=1,y().each(Ie,(ne,ie)=>{yt[ie.group]=1,qt[ie.group]=ie.groupTitle||ie.group,Bt[ie.version]=1}),yt=Object.keys(yt),yt.sort(),de.order&&(yt=Ne(qt,de.order)),Bt=Object.keys(Bt),Bt.sort(i().compare),Bt.reverse();const wt=[];yt.forEach(ne=>{wt.push({group:ne,isHeader:!0,title:qt[ne]});let ie="";Ie.forEach(le=>{le.group===ne&&(ie!==le.name?wt.push({title:le.title,group:ne,name:le.name,type:le.type,version:le.version,url:le.url}):wt.push({title:le.title,group:ne,hidden:!0,name:le.name,type:le.type,version:le.version,url:le.url}),ie=le.name)})});function cr(ne,ie,le){let pe=!1;if(!ie)return pe;const Te=ie.match(/ (.+?)<\/h(1|2)>/gi);return Te&&Te.forEach(function(Le){const Re=Le.substring(2,3),lt=Le.replace(/<.+?>/g,""),_t=Le.match(/id="api-([^-]+)(?:-(.+))?"/),Dt=_t?_t[1]:null,ht=_t?_t[2]:null;Re==="1"&<&&Dt&&(ne.splice(le,0,{group:Dt,isHeader:!0,title:lt,isFixed:!0}),le++,pe=!0),Re==="2"&<&&Dt&&ht&&(ne.splice(le,0,{group:Dt,name:ht,isHeader:!1,title:lt,isFixed:!1,version:"1.0"}),le++)}),pe}let fr;if(de.header&&(fr=cr(wt,de.header.content,0),fr||wt.unshift({group:"_header",isHeader:!0,title:de.header.title==null?bt("General"):de.header.title,isFixed:!0})),de.footer){const ne=wt.length;fr=cr(wt,de.footer.content,wt.length),!fr&&de.footer.title!=null&&wt.splice(ne,0,{group:"_footer",isHeader:!0,title:de.footer.title,isFixed:!0})}const Or=de.title?de.title:"apiDoc: "+de.name+" - "+de.version;y()(document).attr("title",Or),y()("#loader").remove();const kr={nav:wt};y()("#sidenav").append($e(kr)),y()("#generator").append(ge(de)),(0,n.extend)(de,{versions:Bt}),y()("#project").append(me(de)),de.header&&y()("#header").append(De(de.header)),de.footer&&(y()("#footer").append(we(de.footer)),de.template.aloneDisplay&&document.getElementById("api-_footer").classList.add("hide"));const Mt={};let Cr="";yt.forEach(function(ne){const ie=[];let le="",pe={},Te=ne,Le="";Mt[ne]={},Ie.forEach(function(Re){ne===Re.group&&(le!==Re.name?(Ie.forEach(function(lt){ne===lt.group&&Re.name===lt.name&&(Object.prototype.hasOwnProperty.call(Mt[Re.group],Re.name)||(Mt[Re.group][Re.name]=[]),Mt[Re.group][Re.name].push(lt.version))}),pe={article:Re,versions:Mt[Re.group][Re.name]}):pe={article:Re,hidden:!0,versions:Mt[Re.group][Re.name]},de.sampleUrl&&de.sampleUrl===!0&&(de.sampleUrl=window.location.origin),de.url&&pe.article.url.substr(0,4).toLowerCase()!=="http"&&(pe.article.url=de.url+pe.article.url),oe(pe,Re),Re.groupTitle&&(Te=Re.groupTitle),Re.groupDescription&&(Le=Re.groupDescription),ie.push({article:Y(pe),group:Re.group,name:Re.name,aloneDisplay:de.template.aloneDisplay}),le=Re.name)}),pe={group:ne,title:Te,description:Le,articles:ie,aloneDisplay:de.template.aloneDisplay},Cr+=Ce(pe)}),y()("#sections").append(Cr),de.template.aloneDisplay||(document.body.dataset.spy="scroll",y()("body").scrollspy({target:"#scrollingNav"})),y()(".form-control").on("focus change",function(){y()(this).removeClass("border-danger")}),y()(".sidenav").find("a").on("click",function(ne){ne.preventDefault();const ie=this.getAttribute("href");if(de.template.aloneDisplay){const le=document.querySelector(".sidenav > li.active");le&&le.classList.remove("active"),this.parentNode.classList.add("active")}else{const le=document.querySelector(ie);le&&y()("html,body").animate({scrollTop:le.offsetTop},400)}window.location.hash=ie});function St(ne){let ie=!1;return y().each(ne,le=>{ie=ie||(0,n.some)(ne[le],pe=>pe.type)}),ie}function qr(){y()('button[data-toggle="popover"]').popover().click(function(ie){ie.preventDefault()});const ne=y()("#version strong").html();if(y()("#sidenav li").removeClass("is-new"),de.template.withCompare&&y()("#sidenav li[data-version='"+ne+"']").each(function(){const ie=y()(this).data("group"),le=y()(this).data("name"),pe=y()("#sidenav li[data-group='"+ie+"'][data-name='"+le+"']").length,Te=y()("#sidenav li[data-group='"+ie+"'][data-name='"+le+"']").index(y()(this));(pe===1||Te===pe-1)&&y()(this).addClass("is-new")}),y()(".nav-tabs-examples a").click(function(ie){ie.preventDefault(),y()(this).tab("show")}),y()(".nav-tabs-examples").find("a:first").tab("show"),y()(".sample-request-content-type-switch").change(function(){y()(this).val()==="body-form-data"?(y()("#sample-request-body-json-input-"+y()(this).data("id")).hide(),y()("#sample-request-body-form-input-"+y()(this).data("id")).show()):(y()("#sample-request-body-form-input-"+y()(this).data("id")).hide(),y()("#sample-request-body-json-input-"+y()(this).data("id")).show())}),de.template.aloneDisplay&&(y()(".show-group").click(function(){const ie="."+y()(this).attr("data-group")+"-group",le="."+y()(this).attr("data-group")+"-article";y()(".show-api-group").addClass("hide"),y()(ie).removeClass("hide"),y()(".show-api-article").addClass("hide"),y()(le).removeClass("hide")}),y()(".show-api").click(function(){const ie=this.getAttribute("href").substring(1),le=document.getElementById("version").textContent.trim(),pe=`.${this.dataset.name}-article`,Te=`[id="${ie}-${le}"]`,Le=`.${this.dataset.group}-group`;y()(".show-api-group").addClass("hide"),y()(Le).removeClass("hide"),y()(".show-api-article").addClass("hide");let Re=y()(pe);y()(Te).length&&(Re=y()(Te).parent()),Re.removeClass("hide"),ie.match(/_(header|footer)/)&&document.getElementById(ie).classList.remove("hide")})),de.template.aloneDisplay||y()("body").scrollspy("refresh"),de.template.aloneDisplay){const ie=decodeURI(window.location.hash);if(ie!=null&&ie.length!==0){const le=document.getElementById("version").textContent.trim(),pe=document.querySelector(`li .${ie.slice(1)}-init`),Te=document.querySelector(`li[data-version="${le}"] .show-api.${ie.slice(1)}-init`);let Le=pe;Te&&(Le=Te),Le.click()}}}function M(ne){typeof ne=="undefined"?ne=y()("#version strong").html():y()("#version strong").html(ne),y()("article").addClass("hide"),y()("#sidenav li:not(.nav-fixed)").addClass("hide");const ie={};document.querySelectorAll("article[data-version]").forEach(le=>{const pe=le.dataset.group,Te=le.dataset.name,Le=le.dataset.version,Re=pe+Te;!ie[Re]&&i().lte(Le,ne)&&(ie[Re]=!0,document.querySelector(`article[data-group="${pe}"][data-name="${Te}"][data-version="${Le}"]`).classList.remove("hide"),document.querySelector(`#sidenav li[data-group="${pe}"][data-name="${Te}"][data-version="${Le}"]`).classList.remove("hide"),document.querySelector(`#sidenav li.nav-header[data-group="${pe}"]`).classList.remove("hide"))}),y()("article[data-version]").each(function(le){const pe=y()(this).data("group");y()("section#api-"+pe).removeClass("hide"),y()("section#api-"+pe+" article:visible").length===0?y()("section#api-"+pe).addClass("hide"):y()("section#api-"+pe).removeClass("hide")})}if(M(),y()("#versions li.version a").on("click",function(ne){ne.preventDefault(),M(y()(this).html())}),y()("#compareAllWithPredecessor").on("click",ee),y()("article .versions li.version a").on("click",X),y().urlParam=function(ne){const ie=new RegExp("[\\?&]"+ne+"=([^&#]*)").exec(window.location.href);return ie&&ie[1]?ie[1]:null},y().urlParam("compare")&&y()("#compareAllWithPredecessor").trigger("click"),window.location.hash){const ne=decodeURI(window.location.hash);y()(ne).length>0&&y()("html,body").animate({scrollTop:parseInt(y()(ne).offset().top)},0)}document.querySelector('[data-toggle="offcanvas"]').addEventListener("click",function(){const ne=document.querySelector(".row-offcanvas");ne&&ne.classList.toggle("active")}),y()("#scrollingNav .sidenav-search input.search").focus(),y()('[data-action="filter-search"]').on("keyup",z(ne=>{const ie=ne.currentTarget.value.toLowerCase();y()(".sidenav a.nav-list-item").filter((le,pe)=>y()(pe).toggle(y()(pe).text().toLowerCase().indexOf(ie)>-1))},200)),y()("span.search-reset").on("click",function(){y()("#scrollingNav .sidenav-search input.search").val("").focus(),y()(".sidenav").find("a.nav-list-item").show()});function z(ne,ie){let le=null;return(...pe)=>{clearTimeout(le),le=setTimeout(ne.bind(this,...pe),ie||0)}}function X(ne){ne.preventDefault();const ie=y()(this).parents("article"),le=y()(this).html(),pe=ie.find(".version"),Te=pe.find("strong").html();pe.find("strong").html(le);const Le=ie.data("group"),Re=ie.data("name"),lt=ie.data("version"),_t=ie.data("compare-version");if(_t!==le&&!(!_t&<===le)){if(_t&&Mt[Le][Re][0]===le||lt===le)_e(Le,Re,lt);else{let Dt={},ht={};y().each(et[Le][Re],function(oi,Gr){Gr.version===lt&&(Dt=Gr),Gr.version===le&&(ht=Gr)});const ot={article:Dt,compare:ht,versions:Mt[Le][Re]};ot.article.id=ot.article.group+"-"+ot.article.name+"-"+ot.article.version,ot.article.id=ot.article.id.replace(/\./g,"_"),ot.compare.id=ot.compare.group+"-"+ot.compare.name+"-"+ot.compare.version,ot.compare.id=ot.compare.id.replace(/\./g,"_");let rt=Dt;rt.header&&rt.header.fields&&(ot._hasTypeInHeaderFields=St(rt.header.fields)),rt.parameter&&rt.parameter.fields&&(ot._hasTypeInParameterFields=St(rt.parameter.fields)),rt.error&&rt.error.fields&&(ot._hasTypeInErrorFields=St(rt.error.fields)),rt.success&&rt.success.fields&&(ot._hasTypeInSuccessFields=St(rt.success.fields)),rt.info&&rt.info.fields&&(ot._hasTypeInInfoFields=St(rt.info.fields)),rt=ht,ot._hasTypeInHeaderFields!==!0&&rt.header&&rt.header.fields&&(ot._hasTypeInHeaderFields=St(rt.header.fields)),ot._hasTypeInParameterFields!==!0&&rt.parameter&&rt.parameter.fields&&(ot._hasTypeInParameterFields=St(rt.parameter.fields)),ot._hasTypeInErrorFields!==!0&&rt.error&&rt.error.fields&&(ot._hasTypeInErrorFields=St(rt.error.fields)),ot._hasTypeInSuccessFields!==!0&&rt.success&&rt.success.fields&&(ot._hasTypeInSuccessFields=St(rt.success.fields)),ot._hasTypeInInfoFields!==!0&&rt.info&&rt.info.fields&&(ot._hasTypeInInfoFields=St(rt.info.fields));const fn=Ae(ot);ie.after(fn),ie.next().find(".versions li.version a").on("click",X),y()("#sidenav li[data-group='"+Le+"'][data-name='"+Re+"'][data-version='"+Te+"']").addClass("has-modifications"),ie.remove()}qr(),h().highlightAll()}}function ee(ne){ne.preventDefault(),y()("article:visible .versions").each(function(){const le=y()(this).parents("article").data("version");let pe=null;y()(this).find("li.version a").each(function(){y()(this).html() {Object.keys(ne).forEach(Te=>{ne[Te].replace(/_/g," ")===pe&&le.push(Te)})}),Object.keys(ne).forEach(pe=>{le.indexOf(pe)===-1&&le.push(pe)}),le}qr()}})()})(); diff --git a/enterprise/next/apidoc/index.html b/enterprise/next/apidoc/index.html index 72b09791802..a37e5758e30 100644 --- a/enterprise/next/apidoc/index.html +++ b/enterprise/next/apidoc/index.html @@ -5,15 +5,15 @@ - - - - - - - - - + + + + + + + + + @@ -1042,6 +1042,6 @@ {{__ "Request Body"}}
- +