@elliemae/pui-scripting-object 1.54.4 → 1.55.0

package/build/docs/assets/js/fd475d14.c53d9a61.js

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