@elliemae/pui-scripting-object 1.51.2 → 1.54.4

package/build/docs/assets/js/f7a28957.c081adee.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[4118],{23085:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/type-aliases/Tool","title":"Tool","description":"Properties","source":"@site/docs/api/type-aliases/Tool.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Tool","permalink":"/scripting-object/api/type-aliases/Tool","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/Tool.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"TokenInfo","permalink":"/scripting-object/api/type-aliases/TokenInfo"},"next":{"title":"TpoCompanyDetails","permalink":"/scripting-object/api/type-aliases/TpoCompanyDetails"}}');var o=n(86070),s=n(90116);const a={},r="Tool",l={},c=[{value:"Properties",id:"properties",level:2},{value:"entityName",id:"entityname",level:3}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"tool",children:"Tool"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"type Tool = {\n  entityName: string;\n};\n"})}),"\n",(0,o.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(t.h3,{id:"entityname",children:"entityName"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"entityName: string;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var i=n(30758);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/f8befd8b.99103168.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[1234],{90116:(e,r,d)=>{d.d(r,{R:()=>n,x:()=>t});var s=d(30758);const i={},c=s.createContext(i);function n(e){const r=s.useContext(c);return s.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),s.createElement(c.Provider,{value:r},e.children)}},99975:(e,r,d)=>{d.r(r),d.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>x,frontMatter:()=>n,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/enumerations/LoanCollection","title":"LoanCollection","description":"Loan collection names","source":"@site/docs/api/enumerations/LoanCollection.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/LoanCollection","permalink":"/scripting-object/api/enumerations/LoanCollection","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/LoanCollection.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"FormType","permalink":"/scripting-object/api/enumerations/FormType"},"next":{"title":"LoanLevelActions","permalink":"/scripting-object/api/enumerations/LoanLevelActions"}}');var i=d(86070),c=d(90116);const n={},t="LoanCollection",o={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function j(e){const r={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"loancollection",children:"LoanCollection"})}),"\n",(0,i.jsx)(r.p,{children:"Loan collection names"}),"\n",(0,i.jsx)(r.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{children:"Enumeration Member"}),(0,i.jsx)(r.th,{children:"Value"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"affiliatedbusinessarrangements"})," ",(0,i.jsx)(r.code,{children:"AffiliatedBusinessArrangements"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"AB0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"alternatenameborrower"})," ",(0,i.jsx)(r.code,{children:"AlternateNameBorrower"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLABAKA0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"alternatenamecoborrower"})," ",(0,i.jsx)(r.code,{children:"AlternateNameCoBorrower"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLACAKA0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"borrowercreditreports"})," ",(0,i.jsx)(r.code,{children:"BorrowerCreditReports"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"BCRED0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"borroweremployer"})," ",(0,i.jsx)(r.code,{children:"BorrowerEmployer"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"BE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"borrowerresidence"})," ",(0,i.jsx)(r.code,{children:"BorrowerResidence"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"BR0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"coborrowercreditreports"})," ",(0,i.jsx)(r.code,{children:"CoBorrowerCreditReports"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"CCRED0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"coborroweremployer"})," ",(0,i.jsx)(r.code,{children:"CoBorrowerEmployer"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"CE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"coborrowerresidence"})," ",(0,i.jsx)(r.code,{children:"CoBorrowerResidence"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"CR0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"correspondentotherinsurances"})," ",(0,i.jsx)(r.code,{children:"CorrespondentOtherInsurances"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"CORROI0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"depositoryinformation"})," ",(0,i.jsx)(r.code,{children:"DepositoryInformation"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"DD0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"disclosures"})," ",(0,i.jsx)(r.code,{children:"Disclosures"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"DISC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"earlycheck"})," ",(0,i.jsx)(r.code,{children:"EarlyCheck"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"EC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"escrow"})," ",(0,i.jsx)(r.code,{children:"Escrow"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"HUD0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"giftorgrant"})," ",(0,i.jsx)(r.code,{children:"GiftOrGrant"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLARGG0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"goodfaithchangeofcircumstance"})," ",(0,i.jsx)(r.code,{children:"GoodFaithChangeOfCircumstance"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"XCOC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"gserepandwarranttracker"})," ",(0,i.jsx)(r.code,{children:"GSERepAndWarrantTracker"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TQLGSE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"homecounselingprovider"})," ",(0,i.jsx)(r.code,{children:"HomeCounselingProvider"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"HC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"irs4506record"})," ",(0,i.jsx)(r.code,{children:"IRS4506Record"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"AR0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"irs4506trecord"})," ",(0,i.jsx)(r.code,{children:"IRS4506TRecord"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"IR0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"itemizedescrowpayment"})," ",(0,i.jsx)(r.code,{children:"ItemizedEscrowPayment"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"AEA0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"liabilityinformation"})," ",(0,i.jsx)(r.code,{children:"LiabilityInformation"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"FL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"loanprograms"})," ",(0,i.jsx)(r.code,{children:"LoanPrograms"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"LP0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"mortgageproperty"})," ",(0,i.jsx)(r.code,{children:"MortgageProperty"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"FM0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"nonborrowingownerfilecontact"})," ",(0,i.jsx)(r.code,{children:"NonBorrowingOwnerFileContact"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"NBOC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"nyfees"})," ",(0,i.jsx)(r.code,{children:"NYFees"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"NYFEES0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"otherassets"})," ",(0,i.jsx)(r.code,{children:"OtherAssets"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLAROA0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"otherborroweremployer"})," ",(0,i.jsx)(r.code,{children:"OtherBorrowerEmployer"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"FBE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"othercoborroweremployer"})," ",(0,i.jsx)(r.code,{children:"OtherCoBorrowerEmployer"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"FCE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"otherincome"})," ",(0,i.jsx)(r.code,{children:"OtherIncome"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLAROIS0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"otherliabilitiesordepository"})," ",(0,i.jsx)(r.code,{children:"OtherLiabilitiesOrDepository"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLAROL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"propertyvaluations"})," ",(0,i.jsx)(r.code,{children:"PropertyValuations"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"PVAL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"regzdrawrepayperioddraw"})," ",(0,i.jsx)(r.code,{children:"REGZDrawRepayPeriodDraw"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"HTD0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"regzdrawrepayperiodrepay"})," ",(0,i.jsx)(r.code,{children:"REGZDrawRepayPeriodRepay"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"HTR0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"riders"})," ",(0,i.jsx)(r.code,{children:"Riders"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"RIDER0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"scenarios"})," ",(0,i.jsx)(r.code,{children:"Scenarios"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"SCEN0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"settlementserviceprovider"})," ",(0,i.jsx)(r.code,{children:"SettlementServiceProvider"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"SP0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"specialfeaturecodes"})," ",(0,i.jsx)(r.code,{children:"SpecialFeatureCodes"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"SFC0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"tqlborrower4506torders"})," ",(0,i.jsx)(r.code,{children:"TQLBorrower4506TOrders"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TQL4506T0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"tqlcomplianceorderslastalert"})," ",(0,i.jsx)(r.code,{children:"TQLComplianceOrdersLastAlert"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TQLCOMPLIANCEALERT0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"tqldocumentdeliveredtoinvestor"})," ",(0,i.jsx)(r.code,{children:"TQLDocumentDeliveredToInvestor"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TQLDOCDATE0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"tqlfraudorders"})," ",(0,i.jsx)(r.code,{children:"TQLFraudOrders"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TQLFRAUDALERT0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"trustaccounttransactiondescription"})," ",(0,i.jsx)(r.code,{children:"TrustAccountTransactionDescription"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TA0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"ucdadjustmenttype"})," ",(0,i.jsx)(r.code,{children:"UCDAdjustmentType"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"UNFL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"valuation"})," ",(0,i.jsx)(r.code,{children:"Valuation"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"VAL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"verificationofadditionalloans"})," ",(0,i.jsx)(r.code,{children:"VerificationOfAdditionalLoans"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"URLARAL0000"'})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsxs)(r.td,{children:[(0,i.jsx)("a",{id:"vestingparty"})," ",(0,i.jsx)(r.code,{children:"VestingParty"})]}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:'"TR0000"'})})]})]})]})]})}function x(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]);

package/build/docs/assets/js/f920ab10.7f0d630d.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[8016],{87531:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/enumerations/TokenType","title":"TokenType","description":"token type","source":"@site/docs/api/enumerations/TokenType.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/TokenType","permalink":"/scripting-object/api/enumerations/TokenType","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/TokenType.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ToastType","permalink":"/scripting-object/api/enumerations/ToastType"},"next":{"title":"IAnalytics","permalink":"/scripting-object/api/interfaces/IAnalytics"}}');var r=n(86070),s=n(90116);const o={},a="TokenType",c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"tokentype",children:"TokenType"})}),"\n",(0,r.jsx)(t.p,{children:"token type"}),"\n",(0,r.jsx)(t.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Enumeration Member"}),(0,r.jsx)(t.th,{children:"Value"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"bearer"})," ",(0,r.jsx)(t.code,{children:"BEARER"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"Bearer"'})}),(0,r.jsx)(t.td,{children:"Bearer token type"})]})})]})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var i=n(30758);const r={},s=i.createContext(r);function o(e){const t=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fbbf57d3.06f80f81.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3752],{24232:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"api/enumerations/FormType","title":"FormType","description":"type of the form","source":"@site/docs/api/enumerations/FormType.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/FormType","permalink":"/scripting-object/api/enumerations/FormType","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/FormType.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EditModes","permalink":"/scripting-object/api/enumerations/EditModes"},"next":{"title":"LoanCollection","permalink":"/scripting-object/api/enumerations/LoanCollection"}}');var i=n(86070),o=n(90116);const s={},c="FormType",d={},a=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"formtype",children:"FormType"})}),"\n",(0,i.jsx)(t.p,{children:"type of the form"}),"\n",(0,i.jsx)(t.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Enumeration Member"}),(0,i.jsx)(t.th,{children:"Value"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"custom_form"})," ",(0,i.jsx)(t.code,{children:"CUSTOM_FORM"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"CUSTOM_FORM"'})}),(0,i.jsx)(t.td,{children:"custom form"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"standard_form"})," ",(0,i.jsx)(t.code,{children:"STANDARD_FORM"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"STANDARD_FORM"'})}),(0,i.jsx)(t.td,{children:"standard form"})]})]})]})]})}function m(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(30758);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fd475d14.22d6919b.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[9994],{22618:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});const t=JSON.parse('{"id":"api/type-aliases/LaunchCategoryOptions","title":"LaunchCategoryOptions","description":"options to launch service order integration by category","source":"@site/docs/api/type-aliases/LaunchCategoryOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LaunchCategoryOptions","permalink":"/scripting-object/api/type-aliases/LaunchCategoryOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/LaunchCategoryOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LIB\\\\_NAME","permalink":"/scripting-object/api/type-aliases/LIB_NAME"},"next":{"title":"LaunchProviderOptions","permalink":"/scripting-object/api/type-aliases/LaunchProviderOptions"}}');var i=n(86070),s=n(90116);const a={},d="LaunchCategoryOptions",c={},o=[{value:"Properties",id:"properties",level:2},{value:"additionalData?",id:"additionaldata",level:3},{value:"excludeEVPProviders?",id:"excludeevpproviders",level:3},{value:"redirectParams",id:"redirectparams",level:3},{value:"serviceOrderId?",id:"serviceorderid",level:3},{value:"settings?",id:"settings",level:3},{value:"source",id:"source",level:3},{value:"transactionId?",id:"transactionid",level:3}];function l(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"launchcategoryoptions",children:"LaunchCategoryOptions"})}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"type LaunchCategoryOptions = {\n  additionalData?: any;\n  excludeEVPProviders?: boolean;\n  redirectParams: {\n     targetName: string;\n     targetParams?: Record<string, string>;\n     targetType: NavigationType;\n  };\n  serviceOrderId?: string;\n  settings?: any;\n  source: string;\n  transactionId?: string;\n};\n"})}),"\n",(0,i.jsx)(r.p,{children:"options to launch service order integration by category"}),"\n",(0,i.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h3,{id:"additionaldata",children:"additionalData?"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"optional additionalData: any;\n"})}),"\n",(0,i.jsx)(r.p,{children:"additional data needed for the service order integration"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"excludeevpproviders",children:"excludeEVPProviders?"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"optional excludeEVPProviders: boolean;\n"})}),"\n",(0,i.jsx)(r.p,{children:"flag to exclude EVP providers from the service orders"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"redirectparams",children:"redirectParams"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"redirectParams: {\n  targetName: string;\n  targetParams?: Record<string, string>;\n  targetType: NavigationType;\n};\n"})}),"\n",(0,i.jsx)(r.p,{children:"location to redirect to after the service order integration flow is complete."}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{children:"Name"}),(0,i.jsx)(r.th,{children:"Type"}),(0,i.jsx)(r.th,{children:"Description"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:"targetName"})}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:"string"})}),(0,i.jsxs)(r.td,{children:["name of redirect location ",(0,i.jsx)(r.strong,{children:"Example"})," ",(0,i.jsx)(r.code,{children:"Services, Secondary Registration etc.,"})]})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:"targetParams?"})}),(0,i.jsxs)(r.td,{children:[(0,i.jsx)(r.code,{children:"Record"}),"<",(0,i.jsx)(r.code,{children:"string"}),", ",(0,i.jsx)(r.code,{children:"string"}),">"]}),(0,i.jsx)(r.td,{children:"additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { 'key1': 'value1', 'key2': 'value2'}, the url will have querystring as services?query={'transactionId':123, 'orderId':456, 'key1': 'value1', 'key2': 'value2'}"})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{children:(0,i.jsx)(r.code,{children:"targetType"})}),(0,i.jsx)(r.td,{children:(0,i.jsx)(r.a,{href:"/scripting-object/api/enumerations/NavigationType",children:(0,i.jsx)(r.code,{children:"NavigationType"})})}),(0,i.jsxs)(r.td,{children:["type of redirect location ",(0,i.jsx)(r.strong,{children:"Example"})," ",(0,i.jsx)(r.code,{children:"NavigationType.STANDARD_FORM"})]})]})]})]}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"serviceorderid",children:"serviceOrderId?"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"optional serviceOrderId: string;\n"})}),"\n",(0,i.jsx)(r.p,{children:"unique id of the existing service order"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"settings",children:"settings?"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"optional settings: any;\n"})}),"\n",(0,i.jsx)(r.p,{children:"settings to be passed to the service order integration"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"source",children:"source"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"source: string;\n"})}),"\n",(0,i.jsxs)(r.p,{children:["source application context that is launching the service order integration\nurn patterned string\nexample: urn:elli:services",":getpricing"]}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"transactionid",children:"transactionId?"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"optional transactionId: string;\n"})}),"\n",(0,i.jsx)(r.p,{children:"unique id of the existing service order transaction"})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},90116:(e,r,n)=>{n.d(r,{R:()=>a,x:()=>d});var t=n(30758);const i={},s=t.createContext(i);function a(e){const r=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/fdf27b93.2537f5f4.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[7738],{18532:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/interfaces/IAnalytics","title":"IAnalytics","description":"Methods to collect various business analytics & performance related events and report the same","source":"@site/docs/api/interfaces/IAnalytics.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/IAnalytics","permalink":"/scripting-object/api/interfaces/IAnalytics","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/IAnalytics.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"TokenType","permalink":"/scripting-object/api/enumerations/TokenType"},"next":{"title":"IApplication","permalink":"/scripting-object/api/interfaces/IApplication"}}');var r=i(86070),t=i(90116);const a={},l="IAnalytics",d={},c=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"_dispose()?",id:"_dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"_toJSON()",id:"_tojson",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"deleteTimingEventSamplingRatio()",id:"deletetimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters",level:4},{value:"names",id:"names",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Example",id:"example",level:4},{value:"endTiming()",id:"endtiming",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"start",id:"start",level:5},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Example",id:"example-1",level:4},{value:"getAllTimingEventSamplingRatios()",id:"getalltimingeventsamplingratios",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Example",id:"example-2",level:4},{value:"getTimingEventSamplingRatio()",id:"gettimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"names",id:"names-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-3",level:4},{value:"sendBAEvent()",id:"sendbaevent",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"event",id:"event",level:5},{value:"Returns",id:"returns-6",level:4},{value:"setTimingEventSamplingRatio()",id:"settimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"ratios",id:"ratios",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-4",level:4},{value:"startTiming()",id:"starttiming",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"name",id:"name",level:5},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4}];function o(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"ianalytics",children:"IAnalytics"})}),"\n",(0,r.jsx)(n.p,{children:"Methods to collect various business analytics & performance related events and report the same"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,r.jsx)(n.code,{children:"_dispose"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,r.jsx)(n.code,{children:"RemotingScriptingObject"})})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,r.jsx)(n.code,{children:"_toJSON"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deletetimingeventsamplingratio",children:"deleteTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"deleteTimingEventSamplingRatio(names: string[]): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Remove sampling configuration for timing events\nFalls back to default sampling ratio (0.25)"}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"array of timing event names"}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.deleteTimingEventSamplingRatio(['api-call', 'user-interaction']);\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"endtiming",children:"endTiming()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"endTiming(start: string | PerfMark, options: TimingOptions): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"end timing measure"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"start",children:"start"}),"\n",(0,r.jsx)(n.p,{children:"name used to start timing measure or return value of the startTiming method"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/PerfMark",children:(0,r.jsx)(n.code,{children:"PerfMark"})})]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TimingOptions",children:(0,r.jsx)(n.code,{children:"TimingOptions"})})}),"\n",(0,r.jsx)(n.p,{children:"additional details related to the measurement"}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"a promise that resolves when the timing measurement is ended"}),"\n",(0,r.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });\n// do some work\nawait analytics.endTiming(longTaskMeasurement, { appId: 'myApp', appUrl: 'https://myapp.com' });\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });\n// do some work\nawait analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getalltimingeventsamplingratios",children:"getAllTimingEventSamplingRatios()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getAllTimingEventSamplingRatios(): Record<string, number>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Get all configured timing event sampling ratios"}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with timing event names and their sampling ratios"}),"\n",(0,r.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getAllTimingEventSamplingRatios();\nconsole.log(ratios); // { 'api-call': 0.1, 'user-interaction': 0.5 }\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gettimingeventsamplingratio",children:"getTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getTimingEventSamplingRatio(names: string[]): Record<string, number | undefined>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Get sampling ratios for timing events"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names-1",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"array of timing event names"}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with ratios for each event (undefined if using default)"}),"\n",(0,r.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getTimingEventSamplingRatio(['api-call', 'user-interaction']);\nconsole.log(ratios); // { 'api-call': 0.1, 'user-interaction': 0.5 }\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sendbaevent",children:"sendBAEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"sendBAEvent(event: BAEvent): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"send business analytics event"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"event",children:"event"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/BAEvent",children:(0,r.jsx)(n.code,{children:"BAEvent"})})}),"\n",(0,r.jsx)(n.p,{children:"event to be sent"}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"settimingeventsamplingratio",children:"setTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"setTimingEventSamplingRatio(ratios: Record<string, number>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Set sampling ratios for timing events"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"ratios",children:"ratios"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with timing event names and their sampling ratios (0 to 1)"}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.setTimingEventSamplingRatio({\n  'api-call': 0.1,\n  'user-interaction': 0.5,\n  'page-load': 0.8\n});\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"starttiming",children:"startTiming()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"startTiming(name: string, options: TimingOptions): Promise<PerfMark>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"start timing measure"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced"}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TimingOptions",children:(0,r.jsx)(n.code,{children:"TimingOptions"})})}),"\n",(0,r.jsx)(n.p,{children:"additional details related to the measurement"}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/PerfMark",children:(0,r.jsx)(n.code,{children:"PerfMark"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"a promise that resolves to a performance mark object"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,r.jsx)(n.code,{children:"id"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,r.jsx)(n.code,{children:"objectType"})})]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},90116:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(30758);const r={},t=s.createContext(r);function a(e){const n=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fdf6128b.2af9aa1e.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3749],{47869:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/type-aliases/SystemAdministration","title":"SystemAdministration","description":"Properties","source":"@site/docs/api/type-aliases/SystemAdministration.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/SystemAdministration","permalink":"/scripting-object/api/type-aliases/SystemAdministration","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/SystemAdministration.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"StyleOptions","permalink":"/scripting-object/api/type-aliases/StyleOptions"},"next":{"title":"TableRowCriteria","permalink":"/scripting-object/api/type-aliases/TableRowCriteria"}}');var n=i(86070),r=i(90116);const a={},o="SystemAdministration",c={},l=[{value:"Properties",id:"properties",level:2},{value:"access",id:"access",level:3},{value:"rights",id:"rights",level:3}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"systemadministration",children:"SystemAdministration"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"type SystemAdministration = {\n  access: boolean;\n  rights: string[];\n};\n"})}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"access",children:"access"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"access: boolean;\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"rights",children:"rights"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"rights: string[];\n"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>o});var s=i(30758);const n={},r=s.createContext(n);function a(e){const t=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);