@elliemae/pui-scripting-object 1.51.3 → 1.54.4

package/build/docs/assets/js/d5b7f03b.e53d2761.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3434],{6515:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/interfaces/ITransaction","title":"ITransaction","description":"Provides your applications lender/borrower-facing view with the necessary handles to model your application\'s","source":"@site/docs/api/interfaces/ITransaction.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/ITransaction","permalink":"/scripting-object/api/interfaces/ITransaction","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/ITransaction.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IStyling","permalink":"/scripting-object/api/interfaces/IStyling"},"next":{"title":"ITransactionTemplate","permalink":"/scripting-object/api/interfaces/ITransactionTemplate"}}');var r=t(86070),s=t(90116);const a={},o="ITransaction",c={},l=[{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:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-2",level:4},{value:"close()",id:"close",level:3},{value:"Returns",id:"returns-3",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-4",level:4},{value:"createEvent()",id:"createevent",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"createResource()",id:"createresource",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"options",id:"options-2",level:5},{value:"Returns",id:"returns-6",level:4},{value:"error()",id:"error",level:3},{value:"Returns",id:"returns-7",level:4},{value:"get()",id:"get",level:3},{value:"Returns",id:"returns-8",level:4},{value:"getOrigin()",id:"getorigin",level:3},{value:"Returns",id:"returns-9",level:4},{value:"refreshOrigin()",id:"refreshorigin",level:3},{value:"Returns",id:"returns-10",level:4},{value:"set()",id:"set",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"options",id:"options-3",level:5},{value:"Returns",id:"returns-11",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"options",id:"options-4",level:5},{value:"Returns",id:"returns-12",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 d(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,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"itransaction",children:"ITransaction"})}),"\n",(0,r.jsx)(n.p,{children:"Provides your applications lender/borrower-facing view with the necessary handles to model your application's\ntransactional interaction with the EPC platform.\nAllows access to an interactive session's origination context,\ncreate a new transaction,\nupdate an existing transaction,\ncreate events/messages for a transaction, and more."}),"\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:"cancel",children:"cancel()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"cancel(): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigate your users back to where they left off in the host Encompass application,\nafter they have canceled an interaction with your application's user-interface without having\ninitiated a transaction request (or any other related task) that they were working on.\nThis signals a cancelation outcome to the host Encompass application -\nhow this is handled by the host upon user navigation can vary across applications"}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",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:"close",children:"close()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"close(): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigate your users back to where they left off in the host Encompass application,\nafter they are done interacting with your application's user-interface"}),"\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.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"create(options: TransactionDetails): Promise<TransactionInfo>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"initiate a new transaction with your integration"}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\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/TransactionDetails",children:(0,r.jsx)(n.code,{children:"TransactionDetails"})})}),"\n",(0,r.jsx)(n.p,{children:"details of the transaction to be initiated"}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",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/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction id"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"createevent",children:"createEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"createEvent(options: TransactionEvent): Promise<TransactionInfo>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Allow Lenders to initiate an event/message for the subject transaction with your integration"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\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/TransactionEvent",children:(0,r.jsx)(n.code,{children:"TransactionEvent"})})}),"\n",(0,r.jsx)(n.p,{children:"details of the event/message to be initiated"}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",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/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction event id"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"createresource",children:"createResource()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"createResource(options: ResourceOptions): Promise<ResourceDetails>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Allow Lenders to use your integration to upload files from their\nlocal drive as an attachment to a new transaction.\nThis method returns a URL and authorization token,\nwhich are to be used to stream the selected file as binary content to the EPC platform"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-2",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ResourceOptions",children:(0,r.jsx)(n.code,{children:"ResourceOptions"})})}),"\n",(0,r.jsx)(n.p,{children:"details of the resource to be uploaded"}),"\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.a,{href:"/scripting-object/api/type-aliases/ResourceDetails",children:(0,r.jsx)(n.code,{children:"ResourceDetails"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"location and authorization header to upload the resource"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"error()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"error(): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigate your users back to where they left off in the host Encompass application,\nafter their has been an error (application error or workflow error) on your integrations user-interface.\nThis signals an error outcome to the host Encompass application -\nhow this is handled by the host upon user navigation can vary across applications"}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",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:"get",children:"get()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get(): Promise<TransactionInfo>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Retrieve the transaction in whose context your integration is operating in, utilized by methods that operate on an existing transaction.\nThe methods that currently fall into this category are:\ntransaction.update\ntransaction.createEvent\nAlthough integrations are free to set the transactional context they are operating in\n(using the transaction.set method) , which may be necessary when providing views that\nallow users to switch between and perform actions on multiple transactions,\nthe host application implicitly alters the transactional context in certain scenarios:"}),"\n",(0,r.jsx)(n.p,{children:"Implicit transaction context setting!\nIf your integration is launched by a user in the context of an existing transaction,\nsuch as from the services page on Loan Officer Connect, the document icon on the services\nside-nav in Encompass Desktop or on a loan application in Consumer Connect is set to said transaction.\nEvery time a new transaction is created during a user's interaction with your integration,\nthe context is set to the last created transaction.\nIf the integration was initially launched in the context of an existing transaction,\nthe transaction.getOrigin method will always return the original transactionId the integration was launched\nin the context of, no matter how many times the transaction is set in the current interaction.\nYou can leverage this to track the initial transaction context for a user interaction"}),"\n",(0,r.jsx)(n.p,{children:"The current transactional context your integration operates in can be queried using the transaction.get method"}),"\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/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction id details"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getorigin",children:"getOrigin()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getOrigin(): Promise<OriginDetails>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Provide the necessary information for your application's user-interface to:\nAccess transaction origination information and bootstrap its user interaction\nKnow if it was launched in the context of an existing transaction, so it can present the relevant view"}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",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/OriginDetails",children:(0,r.jsx)(n.code,{children:"OriginDetails"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction origination information"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"refreshorigin",children:"refreshOrigin()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"refreshOrigin(): Promise<OriginDetails>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Refresh your application's transaction origination context - if your current one expires.\nThis method returns a new originId and partnerAccessToken - which your application back-end can use to retrieve a refreshed transaction origin:\nA fresh snapshot of the loan data your application is entitled to receive in a transaction origin\nA a fresh snapshot of the user's credential set configured by their Administrator for use with your application"}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",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/OriginDetails",children:(0,r.jsx)(n.code,{children:"OriginDetails"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction origination information"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"set",children:"set()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"set(options: TransactionInfo): Promise<TransactionInfo>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Set the transaction in whose context you want to invoke methods that operate on an existing transaction.\nThe subject transaction must be one that was created for the current loan and EPC product.\nThe methods that currently fall into this category are:\ntransaction.update\ntransaction.createEvent"}),"\n",(0,r.jsx)(n.p,{children:"Although integrations are free to set the transactional context they are operating in,\nwhich may be necessary when providing views that allow users to switch between\nand perform actions on multiple transactions, the host application implicitly\nalters the transactional context in certain scenarios:"}),"\n",(0,r.jsx)(n.p,{children:"Implicit transaction context setting!\nIf your integration is launched by a user in the context of an existing transaction,\nsuch as from the services page on Loan Officer Connect, the document icon\non the services side-nav in Encompass Desktop or when returning to a\nloan application in Consumer Connect, the transactional context is implicitly set to said transaction\nEvery time a new transaction is created during a user's interaction with your integration,\nthe context is set to the last created transaction\nIf the integration was initially launched in the context of an existing transaction,\ntransaction.getOrigin will always return the original transactionId the integration was launched\nin the context of, no matter how many times the transaction is set in the current interaction.\nYou can leverage this to track the initial transaction context for a user interaction"}),"\n",(0,r.jsx)(n.p,{children:"The current transactional context that your integration is operating in can be queried using the transaction.get method."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-3",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})})}),"\n",(0,r.jsx)(n.p,{children:"transaction details"}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",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/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction that has been set"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"update(options: TransactionDetails): Promise<TransactionInfo>;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Allow Lenders to update an existing transaction by attaching new resources or updating\nthe request options associated with the transaction.\nA transaction update will trigger an updated webhook event on the urn:elli:epc",":transaction"," REST resource,\nindicating an updated transaction request is ready for your application to retrieve.\nThe updated transaction request will contain:\nAn updated options object, if set in this method\nAn updated resources array, with the resources set in this method appended to the previously attached set\nBy default, a fresh snapshot of the loan data your application is entitled to receive in the transaction request\nBy default, a fresh snapshot of the user's credential set configured by their Administrator for use with your application"]}),"\n",(0,r.jsx)(n.p,{children:"Request type immutability\nThe type for a lender initiated transaction request can not be updated once created.\nIf you need to support the ability for a lender to change the request type for a transaction they have initiated,\nthe initial transaction must be canceled via a transaction response status update (using the REST API),\nand the lender must initiate a new transaction request with the updated type"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-4",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TransactionDetails",children:(0,r.jsx)(n.code,{children:"TransactionDetails"})})}),"\n",(0,r.jsx)(n.p,{children:"transaction details"}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",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/TransactionInfo",children:(0,r.jsx)(n.code,{children:"TransactionInfo"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"transaction id"}),"\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 h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},90116:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(30758);const r={},s=i.createContext(r);function a(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/d6912e2d.9d2742cf.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[4222],{4606:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>a});const n=JSON.parse('{"id":"api/enumerations/EditModes","title":"EditModes","description":"List of supported edit modes","source":"@site/docs/api/enumerations/EditModes.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/EditModes","permalink":"/scripting-object/api/enumerations/EditModes","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/EditModes.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Scripting Object API","permalink":"/scripting-object/api/"},"next":{"title":"FormType","permalink":"/scripting-object/api/enumerations/FormType"}}');var s=i(86070),d=i(90116);const r={},o="EditModes",c={},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,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"editmodes",children:"EditModes"})}),"\n",(0,s.jsx)(t.p,{children:"List of supported edit modes"}),"\n",(0,s.jsx)(t.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,s.jsxs)(t.table,{children:[(0,s.jsx)(t.thead,{children:(0,s.jsxs)(t.tr,{children:[(0,s.jsx)(t.th,{children:"Enumeration Member"}),(0,s.jsx)(t.th,{children:"Value"}),(0,s.jsx)(t.th,{children:"Description"})]})}),(0,s.jsxs)(t.tbody,{children:[(0,s.jsxs)(t.tr,{children:[(0,s.jsxs)(t.td,{children:[(0,s.jsx)("a",{id:"edit"})," ",(0,s.jsx)(t.code,{children:"EDIT"})]}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:'"EDIT"'})}),(0,s.jsx)(t.td,{children:"edit mode"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsxs)(t.td,{children:[(0,s.jsx)("a",{id:"exclusive_edit"})," ",(0,s.jsx)(t.code,{children:"EXCLUSIVE_EDIT"})]}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:'"EXCLUSIVEEDIT"'})}),(0,s.jsx)(t.td,{children:"exclusive edit mode"})]}),(0,s.jsxs)(t.tr,{children:[(0,s.jsxs)(t.td,{children:[(0,s.jsx)("a",{id:"read_only"})," ",(0,s.jsx)(t.code,{children:"READ_ONLY"})]}),(0,s.jsx)(t.td,{children:(0,s.jsx)(t.code,{children:'"READONLY"'})}),(0,s.jsx)(t.td,{children:"read only mode"})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>o});var n=i(30758);const s={},d=n.createContext(s);function r(e){const t=n.useContext(d);return n.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(s):e.components||s:r(e.components),n.createElement(d.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/d7953049.84cc2689.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[8442],{69109:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>l,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"api/type-aliases/LoanCollectionObject","title":"LoanCollectionObject","description":"Loan collection object","source":"@site/docs/api/type-aliases/LoanCollectionObject.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LoanCollectionObject","permalink":"/scripting-object/api/type-aliases/LoanCollectionObject","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/LoanCollectionObject.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LoanCloseListener()","permalink":"/scripting-object/api/type-aliases/LoanCloseListener"},"next":{"title":"LoanCommittedListener()","permalink":"/scripting-object/api/type-aliases/LoanCommittedListener"}}');var o=i(86070),r=i(90116);const l={},s="LoanCollectionObject",c={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"objectType",id:"objecttype",level:3},{value:"removeAt()",id:"removeat",level:3},{value:"Parameters",id:"parameters",level:4},{value:"index",id:"index",level:5},{value:"applicationIndex",id:"applicationindex",level:5},{value:"Returns",id:"returns",level:4}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"loancollectionobject",children:"LoanCollectionObject"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"type LoanCollectionObject = {\n  id: string;\n  objectType: string;\n  removeAt: (index: number, applicationIndex: number) => void;\n};\n"})}),"\n",(0,o.jsx)(n.p,{children:"Loan collection object"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"id: string;\n"})}),"\n",(0,o.jsx)(n.p,{children:"unique id of the collection. e.g: LoanCollection"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"objectType: string;\n"})}),"\n",(0,o.jsx)(n.p,{children:"object type"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"removeat",children:"removeAt()"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"removeAt: (index: number, applicationIndex: number) => void;\n"})}),"\n",(0,o.jsx)(n.p,{children:"Removes a collection record from the LoanCollection reference"}),"\n",(0,o.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.h5,{id:"index",children:"index"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"number"})}),"\n",(0,o.jsx)(n.p,{children:"Zero based collection index to delete, i.e. use 0 to delete first record from collection. This argument is required. You can also use negative values to delete in reverse order e.g to delete last record use -1, second from last use -2 & so on."}),"\n",(0,o.jsx)(n.h5,{id:"applicationindex",children:"applicationIndex"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"number"})}),"\n",(0,o.jsx)(n.p,{children:"Zero based application index (Borrower Pair Index), use 0 to remove data that belongs to 1st borrower pair. This argument is optional. If this argument is missing, removeAt will perform delete on current selected borrower pair's index"}),"\n",(0,o.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"void"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},90116:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>s});var t=i(30758);const o={},r=t.createContext(o);function l(e){const n=t.useContext(r);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:l(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/d7e348bf.f77d0670.js

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

package/build/docs/assets/js/d978f210.dd0850f0.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[2548],{39929:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>o,frontMatter:()=>l,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"Objects/analytics","title":"Analytics","description":"API Definition","source":"@site/docs/Objects/analytics.md","sourceDirName":"Objects","slug":"/Objects/analytics","permalink":"/scripting-object/Objects/analytics","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/Objects/analytics.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Getting Started","permalink":"/scripting-object/"},"next":{"title":"Application","permalink":"/scripting-object/Objects/application"}}');var i=n(86070),c=n(90116);const l={},r="Analytics",d={},a=[{value:"Methods",id:"methods",level:2},{value:"Events",id:"events",level:2}];function h(e){const t={a:"a",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)(t.header,{children:(0,i.jsx)(t.h1,{id:"analytics",children:"Analytics"})}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"../api/interfaces/IAnalytics",children:"API Definition"})}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Method"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass Web"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"TPO"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Consumer Connect"}),(0,i.jsx)(t.th,{children:"Notes"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IAnalytics#sendbaevent",children:"sendBAEvent"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IAnalytics#starttiming",children:"startTiming"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IAnalytics#endtiming",children:"endTiming"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"events",children:"Events"}),"\n",(0,i.jsx)(t.p,{children:"NA"})]})}function o(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>r});var s=n(30758);const i={},c=s.createContext(i);function l(e){const t=s.useContext(c);return s.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(i):e.components||i:l(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/d9d4cbfc.d3137ca2.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3656],{78622:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"api/enumerations/RecordActions","title":"RecordActions","description":"loan record actions","source":"@site/docs/api/enumerations/RecordActions.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/RecordActions","permalink":"/scripting-object/api/enumerations/RecordActions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/RecordActions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"OriginContext","permalink":"/scripting-object/api/enumerations/OriginContext"},"next":{"title":"RecordViewType","permalink":"/scripting-object/api/enumerations/RecordViewType"}}');var i=n(86070),c=n(90116);const d={},s="RecordActions",o={},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,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"recordactions",children:"RecordActions"})}),"\n",(0,i.jsx)(t.p,{children:"loan record actions"}),"\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:"add"})," ",(0,i.jsx)(t.code,{children:"ADD"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"add"'})}),(0,i.jsx)(t.td,{children:"add record action"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"delete"})," ",(0,i.jsx)(t.code,{children:"DELETE"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"delete"'})}),(0,i.jsx)(t.td,{children:"delete record action"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"replace"})," ",(0,i.jsx)(t.code,{children:"REPLACE"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"replace"'})}),(0,i.jsx)(t.td,{children:"replace record action"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"update"})," ",(0,i.jsx)(t.code,{children:"UPDATE"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"update"'})}),(0,i.jsx)(t.td,{children:"update record action"})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,c.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:()=>d,x:()=>s});var r=n(30758);const i={},c=r.createContext(i);function d(e){const t=r.useContext(c);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/da1d6308.706f5bc0.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[6884],{42534:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/type-aliases/RecordOptions","title":"RecordOptions","description":"options for updating records","source":"@site/docs/api/type-aliases/RecordOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/RecordOptions","permalink":"/scripting-object/api/type-aliases/RecordOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/RecordOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"PurchaseConditions","permalink":"/scripting-object/api/type-aliases/PurchaseConditions"},"next":{"title":"RemotingScriptingObject","permalink":"/scripting-object/api/type-aliases/RemotingScriptingObject"}}');var r=n(86070),o=n(90116);const s={},c="RecordOptions",a={},d=[{value:"Properties",id:"properties",level:2},{value:"action",id:"action",level:3},{value:"contractPath",id:"contractpath",level:3},{value:"data",id:"data",level:3},{value:"view",id:"view",level:3}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"recordoptions",children:"RecordOptions"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"type RecordOptions = {\n  action: RecordActions;\n  contractPath: string;\n  data: LoanRecord[];\n  view: RecordViewType;\n};\n"})}),"\n",(0,r.jsx)(t.p,{children:"options for updating records"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"action",children:"action"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"action: RecordActions;\n"})}),"\n",(0,r.jsx)(t.p,{children:"operation to be performed on record"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"contractpath",children:"contractPath"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"contractPath: string;\n"})}),"\n",(0,r.jsx)(t.p,{children:"loan v3 contract path"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"data",children:"data"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"data: LoanRecord[];\n"})}),"\n",(0,r.jsx)(t.p,{children:"records to be updated"}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"view",children:"view"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"view: RecordViewType;\n"})}),"\n",(0,r.jsx)(t.p,{children:"record view type"})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var i=n(30758);const r={},o=i.createContext(r);function s(e){const t=i.useContext(o);return i.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(r):e.components||r:s(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/dbcee71f.2d94a996.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[9864],{77713:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>s,toc:()=>o});const s=JSON.parse('{"id":"api/enumerations/LogLevels","title":"LogLevels","description":"Log levels","source":"@site/docs/api/enumerations/LogLevels.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/LogLevels","permalink":"/scripting-object/api/enumerations/LogLevels","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/LogLevels.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LoanLevelActions","permalink":"/scripting-object/api/enumerations/LoanLevelActions"},"next":{"title":"ModalSize","permalink":"/scripting-object/api/enumerations/ModalSize"}}');var i=t(86070),r=t(90116);const d={},l="LogLevels",c={},o=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function a(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"loglevels",children:"LogLevels"})}),"\n",(0,i.jsx)(n.p,{children:"Log levels"}),"\n",(0,i.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Enumeration Member"}),(0,i.jsx)(n.th,{children:"Value"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"audit"})," ",(0,i.jsx)(n.code,{children:"AUDIT"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"30"})}),(0,i.jsx)(n.td,{children:"audit log level"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"debug"})," ",(0,i.jsx)(n.code,{children:"DEBUG"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"10"})}),(0,i.jsx)(n.td,{children:"debug log level"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"error"})," ",(0,i.jsx)(n.code,{children:"ERROR"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"50"})}),(0,i.jsx)(n.td,{children:"error log level"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"fatal"})," ",(0,i.jsx)(n.code,{children:"FATAL"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"60"})}),(0,i.jsx)(n.td,{children:"fatal log level"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"info"})," ",(0,i.jsx)(n.code,{children:"INFO"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"20"})}),(0,i.jsx)(n.td,{children:"info log level"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:[(0,i.jsx)("a",{id:"warn"})," ",(0,i.jsx)(n.code,{children:"WARN"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"40"})}),(0,i.jsx)(n.td,{children:"warning log level"})]})]})]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},90116:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>l});var s=t(30758);const i={},r=s.createContext(i);function d(e){const n=s.useContext(r);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(i):e.components||i:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/dc7a9126.b8347a73.js

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

package/build/docs/assets/js/dcdc0a4e.5b4ab14c.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[7887],{8326:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>a,contentTitle:()=>r,default:()=>c,frontMatter:()=>d,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"api/type-aliases/EditModeOptions","title":"EditModeOptions","description":"options for setting loan edit mode","source":"@site/docs/api/type-aliases/EditModeOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/EditModeOptions","permalink":"/scripting-object/api/type-aliases/EditModeOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/EditModeOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EditComment","permalink":"/scripting-object/api/type-aliases/EditComment"},"next":{"title":"EncompassWebServices","permalink":"/scripting-object/api/type-aliases/EncompassWebServices"}}');var s=i(86070),o=i(90116);const d={},r="EditModeOptions",a={},l=[{value:"Properties",id:"properties",level:2},{value:"mode",id:"mode",level:3},{value:"moduleId",id:"moduleid",level:3},{value:"Example",id:"example",level:4}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"editmodeoptions",children:"EditModeOptions"})}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"type EditModeOptions = {\n  mode: EditModes;\n  moduleId: string;\n};\n"})}),"\n",(0,s.jsx)(t.p,{children:"options for setting loan edit mode"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"mode",children:"mode"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"mode: EditModes;\n"})}),"\n",(0,s.jsx)(t.p,{children:"edit mode type"}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"moduleid",children:"moduleId"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"moduleId: string;\n"})}),"\n",(0,s.jsx)(t.p,{children:"module requesting the edit mode change. urn format"}),"\n",(0,s.jsx)(t.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"urn:encompass:efolder\n"})})]})}function c(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>d,x:()=>r});var n=i(30758);const s={},o=n.createContext(s);function d(e){const t=n.useContext(o);return n.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(s):e.components||s:d(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/deb01a76.b0489e25.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[1453],{47849:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/interfaces/ILoan","title":"ILoan","description":"Methods & Events for interacting with an open loan in the application","source":"@site/docs/api/interfaces/ILoan.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/ILoan","permalink":"/scripting-object/api/interfaces/ILoan","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/ILoan.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IHttp","permalink":"/scripting-object/api/interfaces/IHttp"},"next":{"title":"IMemStorage","permalink":"/scripting-object/api/interfaces/IMemStorage"}}');var s=l(86070),r=l(90116);const a={},t="ILoan",c={},d=[{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:"all()",id:"all",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Example",id:"example",level:4},{value:"applyLock()",id:"applylock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"fieldId",id:"fieldid",level:5},{value:"lock",id:"lock",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Example",id:"example-1",level:4},{value:"calculate()",id:"calculate",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Example",id:"example-2",level:4},{value:"commit()",id:"commit",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-3",level:4},{value:"execAction()",id:"execaction",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"type",id:"type",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-6",level:4},{value:"Example",id:"example-4",level:4},{value:"getCollection()",id:"getcollection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"name",id:"name",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Throws",id:"throws",level:4},{value:"Example",id:"example-5",level:4},{value:"getCurrentApplication()",id:"getcurrentapplication",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Example",id:"example-6",level:4},{value:"getField()",id:"getfield",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"id",id:"id",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Throws",id:"throws-1",level:4},{value:"Examples",id:"examples",level:4},{value:"getFieldOptions()",id:"getfieldoptions",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"param",id:"param",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Example",id:"example-7",level:4},{value:"getFields()",id:"getfields",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"ids",id:"ids",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-8",level:4},{value:"isReadOnly()",id:"isreadonly",level:3},{value:"Returns",id:"returns-12",level:4},{value:"merge()",id:"merge",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Example",id:"example-9",level:4},{value:"setCurrentApplication()",id:"setcurrentapplication",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Throws",id:"throws-2",level:4},{value:"Example",id:"example-10",level:4},{value:"setEditMode()",id:"seteditmode",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Example",id:"example-11",level:4},{value:"setFields()",id:"setfields",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"fields",id:"fields",level:5},{value:"Returns",id:"returns-16",level:4},{value:"Example",id:"example-12",level:4},{value:"Properties",id:"properties",level:2},{value:"ApplicationSelected",id:"applicationselected",level:3},{value:"Examples",id:"examples-1",level:4},{value:"Change",id:"change",level:3},{value:"Examples",id:"examples-2",level:4},{value:"Close",id:"close",level:3},{value:"Examples",id:"examples-3",level:4},{value:"Committed",id:"committed",level:3},{value:"Examples",id:"examples-4",level:4},{value:"EditModeChange",id:"editmodechange",level:3},{value:"Examples",id:"examples-5",level:4},{value:"FieldChangeSync",id:"fieldchangesync",level:3},{value:"Examples",id:"examples-6",level:4},{value:"id",id:"id-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"MilestoneCompleted",id:"milestonecompleted",level:3},{value:"Examples",id:"examples-7",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Open",id:"open",level:3},{value:"Examples",id:"examples-8",level:4},{value:"PreCommit",id:"precommit",level:3},{value:"Examples",id:"examples-9",level:4},{value:"PreMilestoneComplete",id:"premilestonecomplete",level:3},{value:"Examples",id:"examples-10",level:4},{value:"Sync",id:"sync",level:3},{value:"Examples",id:"examples-11",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,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"iloan",children:"ILoan"})}),"\n",(0,s.jsx)(n.p,{children:"Methods & Events for interacting with an open loan in the application"}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEvents",children:"LoanEvents"})," for supported events"]}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,s.jsx)(n.code,{children:"_dispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,s.jsx)(n.code,{children:"RemotingScriptingObject"})})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,s.jsx)(n.code,{children:"_toJSON"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"all",children:"all()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"all(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get complete Loan object"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"v3 Loan Object"}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const loanData = await loan.all();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"applylock",children:"applyLock()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"applyLock(fieldId: string, lock: boolean): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies or removes the calculation lock on a loan field."}),"\n",(0,s.jsx)(n.p,{children:"In this way you can enable or disable the lock on a loan field programmatically."}),"\n",(0,s.jsx)(n.p,{children:"Parameters are: ID of the field you want to apply or remove the calculation lock and the status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fieldid",children:"fieldId"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"ID of the field you want to apply or remove the calculation lock"}),"\n",(0,s.jsx)(n.h5,{id:"lock",children:"lock"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.applyLock('4001', true);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"calculate",children:"calculate()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"calculate(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Executes calculations and business rules"}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.calculate();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commit",children:"commit()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"commit(): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Commit all pending changes on the current loan"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.precommit event before committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.committed event after committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Business rule violations will prevent the loan from being committed"}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"loan id"}),"\n",(0,s.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.commit();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"execaction",children:"execAction()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<ActionResponse>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Execute loan level action, this is specific to v3 stateful implementation"}),"\n",(0,s.jsx)(n.p,{children:"Invokes state API with all pending changes in current change-set along with requested loan action"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.sync event after the action is executed"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"type",children:"type"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanLevelActions",children:(0,s.jsx)(n.code,{children:"LoanLevelActions"})})}),"\n",(0,s.jsx)(n.p,{children:"type of action to be executed. e.g. updateCorrespondentBalance"}),"\n",(0,s.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"additional parameters for the action"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ActionResponse",children:(0,s.jsx)(n.code,{children:"ActionResponse"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.execAction('calculateEEMMortgage');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcollection",children:"getCollection()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCollection(name: LoanCollection): Promise<LoanCollectionObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns an object reference of type LoanCollection."}),"\n",(0,s.jsx)(n.p,{children:'Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.'}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanCollection",children:(0,s.jsx)(n.code,{children:"LoanCollection"})})}),"\n",(0,s.jsx)(n.p,{children:"collection template name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCollectionObject",children:(0,s.jsx)(n.code,{children:"LoanCollectionObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"collection object"}),"\n",(0,s.jsx)(n.h4,{id:"throws",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if collection name is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const borrowerEmployer = await loan.getCollection('BorrowerEmployer');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcurrentapplication",children:"getCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCurrentApplication(): Promise<ApplicationInfo>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get the current borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ApplicationInfo",children:(0,s.jsx)(n.code,{children:"ApplicationInfo"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const currentApplication = await loan.getCurrentApplication();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfield",children:"getField()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getField(id: string): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get value of the standard or custom field"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"id",children:"id"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"field id"}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"field value. Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"throws-1",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if field id is empty, null or undefined"}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('4001');\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('URLA.X1');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfieldoptions",children:"getFieldOptions()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFieldOptions(param: FieldOptionsParam): Promise<Record<string, FieldOptions[]>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get options for loan fields / custom form controls"}),"\n",(0,s.jsx)(n.p,{children:"supports both standard & custom loan fields."}),"\n",(0,s.jsx)(n.p,{children:"control Ids takes precedence over field Ids."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"param",children:"param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptionsParam",children:(0,s.jsx)(n.code,{children:"FieldOptionsParam"})})}),"\n",(0,s.jsx)(n.p,{children:"parameter for getting field options"}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptions",children:(0,s.jsx)(n.code,{children:"FieldOptions"})}),"[]>>"]}),"\n",(0,s.jsx)(n.p,{children:"array of field options for each field / control id"}),"\n",(0,s.jsx)(n.h4,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ fieldIds: ['1543', '1544'] });\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ controlIds: ['111', '112'] });\n"})}),"\n",(0,s.jsx)(n.p,{children:"Following is a sample field options for field Id 1543:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" 1543: [\n  {\n    value: 'Manual Underwriting',\n    name: 'Manual Underwriting'\n  },\n  {\n    value: 'DU',\n    name: 'DU'\n  },\n  {\n    value: 'LP',\n    name: 'LP'\n  },\n  {\n    value: 'LQA',\n    name: 'LQA'\n  },\n  {\n    value: 'Other',\n    name: 'Other'\n  }\n]\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfields",children:"getFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFields(ids: string[]): Promise<Record<string, string>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the value of a standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"ids",children:"ids"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The field Ids to get the value of"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">>"]}),"\n",(0,s.jsx)(n.p,{children:"The field values"}),"\n",(0,s.jsx)(n.h4,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValues = await loan.getFields(['4001', '4002']);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"isReadOnly(): Promise<boolean>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the loan is editable or in a read-only state."}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"merge",children:"merge()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"merge(): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Syncs the loan workspace with any changes made by other users."}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.merge();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setcurrentapplication",children:"setCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Switch borrower pair"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.applicationselected event after the borrower pair is switched"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/CurrentApplicationOptions",children:(0,s.jsx)(n.code,{children:"CurrentApplicationOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"throws-2",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if borrower pair infromation is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setCurrentApplication({\n id: '5D3B4A1B-3D3B-4A1B-5D3B-4A1B3D3B4A1B'\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"seteditmode",children:"setEditMode()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setEditMode(options: EditModeOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set UI edit mode for the loan."}),"\n",(0,s.jsx)(n.p,{children:"It doesn't apply loan level lock."}),"\n",(0,s.jsx)(n.p,{children:"Use this api to prevent current user from making edits to the loan file, while a compliance based workflow is in progress"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/EditModeOptions",children:(0,s.jsx)(n.code,{children:"EditModeOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"options for setting edit mode"}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setEditMode({mode: 'READONLY', moduleId: 'urn:encompass:efolder'});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setfields",children:"setFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setFields(fields: Record<string, string>): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set the values of one or more standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Throws an error if non-existing field id is passed. Fields following the non-existing field will not be set."}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.change event for each field that is changed and loan.sync event after all fields are set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fields",children:"fields"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"list of field ids and their values"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setField({'4000': 'John', '4002': 'David'});\n"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"applicationselected",children:"ApplicationSelected"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly ApplicationSelected: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan application is selected"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanApplicationSelectedListener",children:"LoanApplicationSelectedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-1",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.applicationselected',\n callback: ({ eventParams }) => {\n   console.log('Application Selected', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'applicationselected', ({ eventParams }) => {\n console.log('Application Selected', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"change",children:"Change"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Change: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired for each loan change made by the user"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanChangeListener",children:"LoanChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-2",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.change',\n callback: ({ eventParams }) => {\n   console.log('Loan changed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'change', ({ eventParams }) => {\n console.log('Loan changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"close",children:"Close"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Close: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired prior to closing the loan"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCloseListener",children:"LoanCloseListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-3",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.close',\n callback: ({ eventParams }) => {\n   console.log('Loan closing', eventParams);\n   return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'close', ({ eventParams }) => {\n console.log('Loan closing', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"committed",children:"Committed"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Committed: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan changes are committed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCommittedListener",children:"LoanCommittedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-4",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.committed',\n callback: ({ eventParams }) => {\n   console.log('Loan committed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'committed', ({ eventParams }) => {\n console.log('Loan committed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editmodechange",children:"EditModeChange"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly EditModeChange: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan edit mode is changed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEditModeChangeListener",children:"LoanEditModeChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-5",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.editModeChange',\n callback: ({ eventParams }) => {\n   console.log('Loan edit mode changed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'editModeChange', ({ eventParams }) => {\n console.log('Loan edit mode changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fieldchangesync",children:"FieldChangeSync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly FieldChangeSync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when a loan field is changed\nreturn true to further process the field change, false to cancel the field change"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanFieldChangeSyncListener",children:"LoanFieldChangeSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-6",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.fieldChangeSync',\n callback: ({ eventParams }) => {\n   console.log('Loan field changed', eventParams);\n   return true;\n });\n criteria: {\n  fieldId: { eq: 4000 }\n }\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'fieldChangeSync', ({ eventParams }) => {\n console.log('Loan field changed', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",children:"id"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,s.jsx)(n.code,{children:"id"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"milestonecompleted",children:"MilestoneCompleted"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly MilestoneCompleted: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan milestone is completed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanMilestoneCompletedListener",children:"LoanMilestoneCompletedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-7",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.milestoneCompleted',\n callback: ({ eventParams }) => {\n   console.log('Loan milestone completed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'milestoneCompleted', ({ eventParams }) => {\n console.log('Loan milestone completed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,s.jsx)(n.code,{children:"objectType"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"open",children:"Open"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Open: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is opened"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanOpenListener",children:"LoanOpenListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-8",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.open',\n callback: ({ eventParams }) => {\n   console.log('Loan open', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'open', ({ eventParams }) => {\n console.log('Loan open', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"precommit",children:"PreCommit"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreCommit: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired prior to saving and pending changes to the loan"}),"\n",(0,s.jsx)(n.p,{children:"One can use this event to perform custom validation and, via the feedback mechanism, prevent the loan from being saved."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreCommitListener",children:"LoanPreCommitListener"})," handles this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-9",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.precommit',\n callback: ({ eventParams }) => {\n   console.log('Loan precommit', eventParams);\n   return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'precommit', ({ eventParams }) => {\n console.log('Loan precommit', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"premilestonecomplete",children:"PreMilestoneComplete"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreMilestoneComplete: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired when the user attempts to complete a milestone and allows for custom validation, and cancellation, of the process."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreMilestoneCompleteListener",children:"LoanPreMilestoneCompleteListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-10",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.premilestonecomplete',\n callback: ({ eventParams }) => {\n   console.log('Loan pre-milestone complete', eventParams);\n   return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'premilestonecomplete', ({ eventParams }) => {\n console.log('Loan pre-milestone complete', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sync",children:"Sync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Sync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is synced with any changes made by other users or external systems"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanSyncListener",children:"LoanSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-11",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.sync',\n callback: ({ eventParams }) => {\n   console.log('Loan synced', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'sync', ({ eventParams }) => {\n console.log('Loan synced', eventParams);\n});\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},90116:(e,n,l)=>{l.d(n,{R:()=>a,x:()=>t});var i=l(30758);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/dfbfbaf0.14299597.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[7456],{70751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/type-aliases/LoanEditModeChangeListener","title":"LoanEditModeChangeListener()","description":"event handler for loan edit mode change event","source":"@site/docs/api/type-aliases/LoanEditModeChangeListener.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LoanEditModeChangeListener","permalink":"/scripting-object/api/type-aliases/LoanEditModeChangeListener","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/LoanEditModeChangeListener.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LoanCommittedListener()","permalink":"/scripting-object/api/type-aliases/LoanCommittedListener"},"next":{"title":"LoanEditModeEventInfo","permalink":"/scripting-object/api/type-aliases/LoanEditModeEventInfo"}}');var a=t(86070),s=t(90116);const r={},o="LoanEditModeChangeListener()",d={},l=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"eventName",id:"eventname",level:4},{value:"eventOptions?",id:"eventoptions",level:4},{value:"eventParams",id:"eventparams",level:4},{value:"obj",id:"obj",level:4},{value:"Returns",id:"returns",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"loaneditmodechangelistener",children:"LoanEditModeChangeListener()"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"type LoanEditModeChangeListener = (params: {\n  eventName: string;\n  eventOptions?: Record<string, unknown>;\n  eventParams: LoanEditModeEventInfo;\n  obj: ILoan;\n}) => void;\n"})}),"\n",(0,a.jsx)(n.p,{children:"event handler for loan edit mode change event"}),"\n",(0,a.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,a.jsx)(n.p,{children:"event parameters"}),"\n",(0,a.jsx)(n.h4,{id:"eventname",children:"eventName"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"string"})}),"\n",(0,a.jsx)(n.p,{children:"event name"}),"\n",(0,a.jsx)(n.h4,{id:"eventoptions",children:"eventOptions?"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsx)(n.p,{children:"additional options related to the event"}),"\n",(0,a.jsx)(n.h4,{id:"eventparams",children:"eventParams"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEditModeEventInfo",children:(0,a.jsx)(n.code,{children:"LoanEditModeEventInfo"})})}),"\n",(0,a.jsx)(n.p,{children:"loan edit mode change info"}),"\n",(0,a.jsx)(n.h4,{id:"obj",children:"obj"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"/scripting-object/api/interfaces/ILoan",children:(0,a.jsx)(n.code,{children:"ILoan"})})}),"\n",(0,a.jsx)(n.p,{children:"loan object reference"}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"void"})}),"\n",(0,a.jsx)(n.p,{children:"none"})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},90116:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>o});var i=t(30758);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/dfea6595.49fa4164.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[6314],{43768:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/type-aliases/LoanCloseListener","title":"LoanCloseListener()","description":"event handler for loan close event","source":"@site/docs/api/type-aliases/LoanCloseListener.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LoanCloseListener","permalink":"/scripting-object/api/type-aliases/LoanCloseListener","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/LoanCloseListener.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LoanChangeListener()","permalink":"/scripting-object/api/type-aliases/LoanChangeListener"},"next":{"title":"LoanCollectionObject","permalink":"/scripting-object/api/type-aliases/LoanCollectionObject"}}');var i=t(86070),r=t(90116);const a={},o="LoanCloseListener()",l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"eventName",id:"eventname",level:4},{value:"eventOptions?",id:"eventoptions",level:4},{value:"eventParams",id:"eventparams",level:4},{value:"obj",id:"obj",level:4},{value:"Returns",id:"returns",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"loancloselistener",children:"LoanCloseListener()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"type LoanCloseListener = (params: {\n  eventName: string;\n  eventOptions?: Record<string, unknown>;\n  eventParams: Record<string, never>;\n  obj: ILoan;\n}) => boolean;\n"})}),"\n",(0,i.jsx)(n.p,{children:"event handler for loan close event"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,i.jsx)(n.p,{children:"event parameters"}),"\n",(0,i.jsx)(n.h4,{id:"eventname",children:"eventName"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.p,{children:"event name"}),"\n",(0,i.jsx)(n.h4,{id:"eventoptions",children:"eventOptions?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"additional options related to the event"}),"\n",(0,i.jsx)(n.h4,{id:"eventparams",children:"eventParams"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"never"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"loan close info"}),"\n",(0,i.jsx)(n.h4,{id:"obj",children:"obj"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/scripting-object/api/interfaces/ILoan",children:(0,i.jsx)(n.code,{children:"ILoan"})})}),"\n",(0,i.jsx)(n.p,{children:"loan object reference"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.p,{children:"true to close the loan, false otherwise"})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},90116:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var s=t(30758);const i={},r=s.createContext(i);function a(e){const n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/e032a17e.407b920f.js

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

package/build/docs/assets/js/e16c43ed.66613c6b.js

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

package/build/docs/assets/js/e188077b.89085ae4.js

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

package/build/docs/assets/js/e3674c67.910dbc30.js

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

package/build/docs/assets/js/e4882ceb.ce73d180.js

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

package/build/docs/assets/js/e5186767.caf0cbe6.js

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

package/build/docs/assets/js/e577279e.8cb51fd7.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[4672],{29621:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/type-aliases/Events","title":"Events","description":"","source":"@site/docs/api/type-aliases/Events.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Events","permalink":"/scripting-object/api/type-aliases/Events","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/Events.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EventObjects","permalink":"/scripting-object/api/type-aliases/EventObjects"},"next":{"title":"ExportServices","permalink":"/scripting-object/api/type-aliases/ExportServices"}}');var i=n(86070),a=n(90116);const r={},o="Events",c={},p=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"events",children:"Events"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"type Events = ApplicationEvents & FormEvents & GlobalEvents & LoanEvents & ModuleEvents;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,a.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:()=>r,x:()=>o});var s=n(30758);const i={},a=s.createContext(i);function r(e){const t=s.useContext(a);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(i):e.components||i:r(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/e6051847.b8f0e3c1.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3155],{16271:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/interfaces/IEvent","title":"IEvent","description":"base class for events","source":"@site/docs/api/interfaces/IEvent.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/IEvent","permalink":"/scripting-object/api/interfaces/IEvent","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/IEvent.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IAuth","permalink":"/scripting-object/api/interfaces/IAuth"},"next":{"title":"IForm","permalink":"/scripting-object/api/interfaces/IForm"}}');var r=t(86070),s=t(90116);const c={},a="IEvent",o={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"name",id:"name",level:3},{value:"objectId",id:"objectid",level:3}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"ievent",children:"IEvent"})}),"\n",(0,r.jsx)(n.p,{children:"base class for events"}),"\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.p,{children:"unique id of the event"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly name: string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"name of the event"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"objectid",children:"objectId"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly objectId: string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"id of the scripting object from where the event was triggered"})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},90116:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var i=t(30758);const r={},s=i.createContext(r);function c(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/e6321b8b.50c0b970.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[5134],{90116:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var i=t(30758);const a={},s=i.createContext(a);function o(e){const n=i.useContext(s);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(s.Provider,{value:n},e.children)}},92321:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/type-aliases/ApplicationActionCompletedListener","title":"ApplicationActionCompletedListener()","description":"event handler that handles action completed event","source":"@site/docs/api/type-aliases/ApplicationActionCompletedListener.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/ApplicationActionCompletedListener","permalink":"/scripting-object/api/type-aliases/ApplicationActionCompletedListener","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/ApplicationActionCompletedListener.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"AppInfo","permalink":"/scripting-object/api/type-aliases/AppInfo"},"next":{"title":"ApplicationContext","permalink":"/scripting-object/api/type-aliases/ApplicationContext"}}');var a=t(86070),s=t(90116);const o={},r="ApplicationActionCompletedListener()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"eventName",id:"eventname",level:4},{value:"eventOptions?",id:"eventoptions",level:4},{value:"eventParams",id:"eventparams",level:4},{value:"obj",id:"obj",level:4},{value:"Returns",id:"returns",level:2}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"applicationactioncompletedlistener",children:"ApplicationActionCompletedListener()"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"type ApplicationActionCompletedListener = (params: {\n  eventName: string;\n  eventOptions?: Record<string, unknown>;\n  eventParams: ActionInfo;\n  obj: IApplication;\n}) => void;\n"})}),"\n",(0,a.jsx)(n.p,{children:"event handler that handles action completed event"}),"\n",(0,a.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,a.jsx)(n.p,{children:"event parameters"}),"\n",(0,a.jsx)(n.h4,{id:"eventname",children:"eventName"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"string"})}),"\n",(0,a.jsx)(n.p,{children:"event name"}),"\n",(0,a.jsx)(n.h4,{id:"eventoptions",children:"eventOptions?"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"string"}),", ",(0,a.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,a.jsx)(n.p,{children:"additional options related to the event"}),"\n",(0,a.jsx)(n.h4,{id:"eventparams",children:"eventParams"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ActionInfo",children:(0,a.jsx)(n.code,{children:"ActionInfo"})})}),"\n",(0,a.jsx)(n.p,{children:"action info"}),"\n",(0,a.jsx)(n.h4,{id:"obj",children:"obj"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"/scripting-object/api/interfaces/IApplication",children:(0,a.jsx)(n.code,{children:"IApplication"})})}),"\n",(0,a.jsx)(n.p,{children:"application object reference"}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"void"})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}}}]);

package/build/docs/assets/js/e9aa306d.60d4368b.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[7276],{42540:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>n,toc:()=>a});const n=JSON.parse('{"id":"api/enumerations/ModalSize","title":"ModalSize","description":"size of the modal","source":"@site/docs/api/enumerations/ModalSize.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/ModalSize","permalink":"/scripting-object/api/enumerations/ModalSize","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/ModalSize.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LogLevels","permalink":"/scripting-object/api/enumerations/LogLevels"},"next":{"title":"ModalType","permalink":"/scripting-object/api/enumerations/ModalType"}}');var r=i(86070),s=i(90116);const d={},l="ModalSize",o={},a=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function c(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:"modalsize",children:"ModalSize"})}),"\n",(0,r.jsx)(t.p,{children:"size of the modal"}),"\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.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"extra_large"})," ",(0,r.jsx)(t.code,{children:"EXTRA_LARGE"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"xl"'})}),(0,r.jsx)(t.td,{children:"extra large modal"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"large"})," ",(0,r.jsx)(t.code,{children:"LARGE"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"lg"'})}),(0,r.jsx)(t.td,{children:"large modal"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"medium"})," ",(0,r.jsx)(t.code,{children:"MEDIUM"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"md"'})}),(0,r.jsx)(t.td,{children:"medium modal"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"small"})," ",(0,r.jsx)(t.code,{children:"SMALL"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"sm"'})}),(0,r.jsx)(t.td,{children:"small modal"})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>d,x:()=>l});var n=i(30758);const r={},s=n.createContext(r);function d(e){const t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/eb03c37b.a8f9ff33.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[8792],{90116:(e,i,n)=>{n.d(i,{R:()=>l,x:()=>c});var s=n(30758);const t={},r=s.createContext(t);function l(e){const i=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),s.createElement(r.Provider,{value:i},e.children)}},91307:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>o});const s=JSON.parse('{"id":"api/interfaces/IGlobal","title":"IGlobal","description":"The Global object allows for data to be shared between custom forms/tools/plugins within a user\'s session.","source":"@site/docs/api/interfaces/IGlobal.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/IGlobal","permalink":"/scripting-object/api/interfaces/IGlobal","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/IGlobal.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IForm","permalink":"/scripting-object/api/interfaces/IForm"},"next":{"title":"IHttp","permalink":"/scripting-object/api/interfaces/IHttp"}}');var t=n(86070),r=n(90116);const l={},c="IGlobal",a={},o=[{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:"get()",id:"get",level:3},{value:"Parameters",id:"parameters",level:4},{value:"key",id:"key",level:5},{value:"Returns",id:"returns-2",level:4},{value:"set()",id:"set",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"key",id:"key-1",level:5},{value:"value",id:"value",level:5},{value:"overwrite?",id:"overwrite",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Properties",id:"properties",level:2},{value:"Change",id:"change",level:3},{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 d(e){const i={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,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"iglobal",children:"IGlobal"})}),"\n",(0,t.jsx)(i.p,{children:"The Global object allows for data to be shared between custom forms/tools/plugins within a user's session.\nUnlike the Session scripting object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables,\nvalues written to the Global store are visible to all such customizations"}),"\n",(0,t.jsx)(i.p,{children:"The implementation of this object should write the global state data to the host application's sessionStore,\nbut should ensure that the state is isolated away from the host application's state variables. This should be done by creating\nnaming conventions for the global keyspaces, e.g. ssf.global.[key]."}),"\n",(0,t.jsx)(i.p,{children:"In order to ensure that guest applications cannot consume significant amounts of sessionStorage, restrictions should be placed on\nthe number and size of the stored session state. In particular, we can start with these values:\nEach valueObj, when stringified, cannot exceed 5 KB\nTotal global state should be limited to 50 values\nThis will ensure that no guest can consume more than 250 KB of sessionStorage"}),"\n",(0,t.jsxs)(i.p,{children:["See ",(0,t.jsx)(i.a,{href:"/scripting-object/api/type-aliases/GlobalEvents",children:"GlobalEvents"})," for supported events"]}),"\n",(0,t.jsx)(i.h2,{id:"extends",children:"Extends"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsx)(i.li,{children:(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,t.jsx)(i.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,t.jsx)(i.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(i.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,t.jsx)(i.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"void"})}),"\n",(0,t.jsx)(i.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,t.jsx)(i.code,{children:"IScriptingObject"})}),".",(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,t.jsx)(i.code,{children:"_dispose"})})]}),"\n",(0,t.jsx)(i.hr,{}),"\n",(0,t.jsx)(i.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,t.jsx)(i.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,t.jsx)(i.code,{children:"RemotingScriptingObject"})})}),"\n",(0,t.jsx)(i.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,t.jsx)(i.code,{children:"IScriptingObject"})}),".",(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,t.jsx)(i.code,{children:"_toJSON"})})]}),"\n",(0,t.jsx)(i.hr,{}),"\n",(0,t.jsx)(i.h3,{id:"get",children:"get()"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"get(key: string): Promise<string>;\n"})}),"\n",(0,t.jsx)(i.p,{children:"get a value from the global store"}),"\n",(0,t.jsx)(i.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(i.h5,{id:"key",children:"key"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"string"})}),"\n",(0,t.jsx)(i.p,{children:"unique key to identify the value"}),"\n",(0,t.jsx)(i.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.code,{children:"Promise"}),"<",(0,t.jsx)(i.code,{children:"string"}),">"]}),"\n",(0,t.jsx)(i.p,{children:"value stored in the global store"}),"\n",(0,t.jsx)(i.hr,{}),"\n",(0,t.jsx)(i.h3,{id:"set",children:"set()"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"set(\n   key: string, \n   value: unknown, \noverwrite?: boolean): Promise<void>;\n"})}),"\n",(0,t.jsx)(i.p,{children:"set a value in the global store"}),"\n",(0,t.jsx)(i.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsx)(i.h5,{id:"key-1",children:"key"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"string"})}),"\n",(0,t.jsx)(i.p,{children:"unique key to identify the value"}),"\n",(0,t.jsx)(i.h5,{id:"value",children:"value"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"unknown"})}),"\n",(0,t.jsx)(i.p,{children:"value to be stored"}),"\n",(0,t.jsx)(i.h5,{id:"overwrite",children:"overwrite?"}),"\n",(0,t.jsx)(i.p,{children:(0,t.jsx)(i.code,{children:"boolean"})}),"\n",(0,t.jsx)(i.p,{children:"if true, overwrite the value if it already exists. Default is false"}),"\n",(0,t.jsx)(i.h4,{id:"returns-3",children:"Returns"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.code,{children:"Promise"}),"<",(0,t.jsx)(i.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(i.h3,{id:"change",children:"Change"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"readonly Change: IEvent;\n"})}),"\n",(0,t.jsx)(i.p,{children:"event fired when the global state changes"}),"\n",(0,t.jsxs)(i.p,{children:["Use ",(0,t.jsx)(i.a,{href:"/scripting-object/api/type-aliases/GlobalChangeListener",children:"GlobalChangeListener"})," to handle this event"]}),"\n",(0,t.jsx)(i.hr,{}),"\n",(0,t.jsx)(i.h3,{id:"id",children:"id"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,t.jsx)(i.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,t.jsx)(i.code,{children:"IScriptingObject"})}),".",(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,t.jsx)(i.code,{children:"id"})})]}),"\n",(0,t.jsx)(i.hr,{}),"\n",(0,t.jsx)(i.h3,{id:"objecttype",children:"objectType"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,t.jsx)(i.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,t.jsxs)(i.p,{children:[(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,t.jsx)(i.code,{children:"IScriptingObject"})}),".",(0,t.jsx)(i.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,t.jsx)(i.code,{children:"objectType"})})]})]})}function h(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]);

package/build/docs/assets/js/eef1b94c.677197ac.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[266],{15409:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/type-aliases/StyleOptions","title":"StyleOptions","description":"CSS style properties that can be applied to fields and table rows","source":"@site/docs/api/type-aliases/StyleOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/StyleOptions","permalink":"/scripting-object/api/type-aliases/StyleOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/StyleOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"StateInfo","permalink":"/scripting-object/api/type-aliases/StateInfo"},"next":{"title":"SystemAdministration","permalink":"/scripting-object/api/type-aliases/SystemAdministration"}}');var n=t(86070),s=t(90116);const i={},l="StyleOptions",a={},c=[{value:"Properties",id:"properties",level:2},{value:"backgroundColor?",id:"backgroundcolor",level:3},{value:"borderColor?",id:"bordercolor",level:3},{value:"color?",id:"color",level:3}];function p(e){const o={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.header,{children:(0,n.jsx)(o.h1,{id:"styleoptions",children:"StyleOptions"})}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"type StyleOptions = {\n  backgroundColor?: string;\n  borderColor?: string;\n  color?: string;\n};\n"})}),"\n",(0,n.jsx)(o.p,{children:"CSS style properties that can be applied to fields and table rows\nAll color values should be valid CSS color strings (hex, rgb, named colors, etc.)"}),"\n",(0,n.jsx)(o.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(o.h3,{id:"backgroundcolor",children:"backgroundColor?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional backgroundColor: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Background color (CSS color value)"}),"\n",(0,n.jsx)(o.hr,{}),"\n",(0,n.jsx)(o.h3,{id:"bordercolor",children:"borderColor?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional borderColor: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Border color (CSS color value)"}),"\n",(0,n.jsx)(o.hr,{}),"\n",(0,n.jsx)(o.h3,{id:"color",children:"color?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional color: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Text color (CSS color value)"})]})}function d(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},90116:(e,o,t)=>{t.d(o,{R:()=>i,x:()=>l});var r=t(30758);const n={},s=r.createContext(n);function i(e){const o=r.useContext(s);return r.useMemo(function(){return"function"==typeof e?e(o):{...o,...e}},[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),r.createElement(s.Provider,{value:o},e.children)}}}]);

package/build/docs/assets/js/eef5f02b.b3b6e47e.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[984],{74087:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>n,toc:()=>a});const n=JSON.parse('{"id":"api/enumerations/ToastType","title":"ToastType","description":"toast message type","source":"@site/docs/api/enumerations/ToastType.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/ToastType","permalink":"/scripting-object/api/enumerations/ToastType","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/ToastType.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ServiceSetupCategory","permalink":"/scripting-object/api/enumerations/ServiceSetupCategory"},"next":{"title":"TokenType","permalink":"/scripting-object/api/enumerations/TokenType"}}');var r=s(86070),i=s(90116);const c={},o="ToastType",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,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"toasttype",children:"ToastType"})}),"\n",(0,r.jsx)(t.p,{children:"toast message 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.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"error"})," ",(0,r.jsx)(t.code,{children:"ERROR"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"error"'})}),(0,r.jsx)(t.td,{children:"error message"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"info"})," ",(0,r.jsx)(t.code,{children:"INFO"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"info"'})}),(0,r.jsx)(t.td,{children:"info message"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"success"})," ",(0,r.jsx)(t.code,{children:"SUCCESS"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"success"'})}),(0,r.jsx)(t.td,{children:"success message"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"warning"})," ",(0,r.jsx)(t.code,{children:"WARNING"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:'"warning"'})}),(0,r.jsx)(t.td,{children:"warning message"})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},90116:(e,t,s)=>{s.d(t,{R:()=>c,x:()=>o});var n=s(30758);const r={},i=n.createContext(r);function c(e){const t=n.useContext(i);return n.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(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/efde44a5.e6f67a4f.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[9105],{73793:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>p,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/type-aliases/Capabilities","title":"Capabilities","description":"capabilities exposed by the application","source":"@site/docs/api/type-aliases/Capabilities.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Capabilities","permalink":"/scripting-object/api/type-aliases/Capabilities","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/Capabilities.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"BusinessRules","permalink":"/scripting-object/api/type-aliases/BusinessRules"},"next":{"title":"ChangeExpectedDate","permalink":"/scripting-object/api/type-aliases/ChangeExpectedDate"}}');var a=i(86070),n=i(90116);const p={},r="Capabilities",o={},c=[{value:"Properties",id:"properties",level:2},{value:"supportedActions",id:"supportedactions",level:3},{value:"supportedFeatures",id:"supportedfeatures",level:3}];function l(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"capabilities",children:"Capabilities"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"type Capabilities = {\n  supportedActions: string[];\n  supportedFeatures: string[];\n};\n"})}),"\n",(0,a.jsx)(t.p,{children:"capabilities exposed by the application"}),"\n",(0,a.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(t.h3,{id:"supportedactions",children:"supportedActions"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"supportedActions: string[];\n"})}),"\n",(0,a.jsx)(t.p,{children:"supported actions"}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"supportedfeatures",children:"supportedFeatures"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"supportedFeatures: string[];\n"})}),"\n",(0,a.jsx)(t.p,{children:"supported features"})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>p,x:()=>r});var s=i(30758);const a={},n=s.createContext(a);function p(e){const t=s.useContext(n);return s.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(a):e.components||a:p(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/f0886e8a.5677a731.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[9915],{30895:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>x});const l=JSON.parse('{"id":"Objects/styling","title":"Styling","description":"API Definition","source":"@site/docs/Objects/styling.md","sourceDirName":"Objects","slug":"/Objects/styling","permalink":"/scripting-object/Objects/styling","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/Objects/styling.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Session","permalink":"/scripting-object/Objects/session"},"next":{"title":"Transaction","permalink":"/scripting-object/Objects/transaction"}}');var i=n(86070),s=n(90116);const r={},c="Styling",d={},x=[{value:"Architecture",id:"architecture",level:2},{value:"Methods",id:"methods",level:2},{value:"Events",id:"events",level:2}];function a(e){const t={a:"a",h1:"h1",h2:"h2",header:"header",mermaid:"mermaid",p:"p",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)(t.header,{children:(0,i.jsx)(t.h1,{id:"styling",children:"Styling"})}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling",children:"API Definition"})}),"\n",(0,i.jsx)(t.h2,{id:"architecture",children:"Architecture"}),"\n",(0,i.jsx)(t.mermaid,{value:'graph TB\n    subgraph "Microapp / Plugin"\n        MA[Microapp / Plugin Code]\n    end\n\n    subgraph "Styling API"\n        IStyling[IStyling Interface]\n        FieldStyles[Field Styles]\n        TableStyles[Table Row Styles]\n    end\n\n    subgraph "Host Application"\n        Renderer[UI Renderer]\n        StyleEngine[Style Engine]\n        DOM[DOM Elements]\n    end\n\n    MA --\x3e|setFieldStyle| IStyling\n    MA --\x3e|setTableRowStyle| IStyling\n    MA --\x3e|getFieldStyle| IStyling\n    MA --\x3e|getTableRowStyle| IStyling\n\n    IStyling --\x3e|Store| FieldStyles\n    IStyling --\x3e|Store| TableStyles\n\n    FieldStyles --\x3e|Apply| StyleEngine\n    TableStyles --\x3e|Evaluate Criteria| StyleEngine\n\n    StyleEngine --\x3e|Update Styles| Renderer\n    Renderer --\x3e|Render| DOM\n\n    style IStyling fill:#e1f5ff\n    style FieldStyles fill:#fff4e1\n    style TableStyles fill:#fff4e1\n    style StyleEngine fill:#e1ffe1'}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Method"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass Web"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"TPO"}),(0,i.jsx)(t.th,{style:{textAlign:"center"},children:"Consumer Connect"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#getallfieldstyles",children:"getAllFieldStyles"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#getalltablerowstyles",children:"getAllTableRowStyles"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#getfieldstyle",children:"getFieldStyle"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#gettablerowstyle",children:"getTableRowStyle"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#setfieldstyle",children:"setFieldStyle"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"center"},children:(0,i.jsx)(t.a,{href:"../api/interfaces/IStyling#settablerowstyle",children:"setTableRowStyle"})}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,i.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"events",children:"Events"}),"\n",(0,i.jsx)(t.p,{children:"NA"})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>c});var l=n(30758);const i={},s=l.createContext(i);function r(e){const t=l.useContext(s);return l.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:r(e.components),l.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/f1a43501.4a9c34da.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3846],{90116:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var t=s(30758);const i={},a=t.createContext(i);function l(e){const n=t.useContext(a);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(a.Provider,{value:n},e.children)}},96835:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>l,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/type-aliases/MilestoneWorkflowManagement","title":"MilestoneWorkflowManagement","description":"Properties","source":"@site/docs/api/type-aliases/MilestoneWorkflowManagement.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/MilestoneWorkflowManagement","permalink":"/scripting-object/api/type-aliases/MilestoneWorkflowManagement","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/MilestoneWorkflowManagement.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"MilestoneInfo","permalink":"/scripting-object/api/type-aliases/MilestoneInfo"},"next":{"title":"ModalContent","permalink":"/scripting-object/api/type-aliases/ModalContent"}}');var i=s(86070),a=s(90116);const l={},r="MilestoneWorkflowManagement",o={},c=[{value:"Properties",id:"properties",level:2},{value:"acceptFiles",id:"acceptfiles",level:3},{value:"assignLoanTeamMembers",id:"assignloanteammembers",level:3},{value:"changeExpectedDate",id:"changeexpecteddate",level:3},{value:"editComments",id:"editcomments",level:3},{value:"finishMilestones",id:"finishmilestones",level:3},{value:"returnFiles",id:"returnfiles",level:3}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"milestoneworkflowmanagement",children:"MilestoneWorkflowManagement"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"type MilestoneWorkflowManagement = {\n  acceptFiles: AcceptFile[];\n  assignLoanTeamMembers: AssignLoanTeamMember[];\n  changeExpectedDate: ChangeExpectedDate[];\n  editComments: EditComment[];\n  finishMilestones: FinishMilestone[];\n  returnFiles: ReturnFile[];\n};\n"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"acceptfiles",children:"acceptFiles"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"acceptFiles: AcceptFile[];\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"assignloanteammembers",children:"assignLoanTeamMembers"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"assignLoanTeamMembers: AssignLoanTeamMember[];\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changeexpecteddate",children:"changeExpectedDate"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"changeExpectedDate: ChangeExpectedDate[];\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"editcomments",children:"editComments"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"editComments: EditComment[];\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"finishmilestones",children:"finishMilestones"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"finishMilestones: FinishMilestone[];\n"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"returnfiles",children:"returnFiles"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"returnFiles: ReturnFile[];\n"})})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}}}]);

package/build/docs/assets/js/f38a0ed3.1f0e9200.js

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

package/build/docs/assets/js/f5908de6.1929bff3.js

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